{"openapi":"3.0.0","components":{"examples":{},"headers":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"ApiErrorResponse":{"properties":{"traceId":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"},"timestamp":{"type":"string"},"statusCode":{"type":"number","format":"double"}},"required":["traceId","message","path","timestamp","statusCode"],"type":"object"},"Record_string.unknown_":{"properties":{},"additionalProperties":{},"type":"object","description":"Construct a type with a set of properties K of type T"},"HealthcheckResponse":{"properties":{"status":{"type":"string"}},"required":["status"],"type":"object"},"EvictKeyRequest":{"properties":{"apiKeyUuid":{"type":"string"}},"required":["apiKeyUuid"],"type":"object"},"PublicPostImage":{"properties":{"type":{"type":"string"},"alt":{"type":"string"},"src":{"type":"string"}},"required":["type","alt","src"],"type":"object"},"PublicPost":{"properties":{"postUrl":{"type":"string"},"postText":{"type":"string"},"claps":{"type":"number","format":"double"},"publishedDate":{"type":"string"},"postImage":{"$ref":"#/components/schemas/PublicPostImage"},"feedImageUrl":{"type":"string"},"feedName":{"type":"string"},"postId":{"type":"string"},"feedId":{"type":"string"}},"required":["postUrl","postText","claps","publishedDate","postImage","feedImageUrl","feedName","postId","feedId"],"type":"object"},"ListResponse_Record_string.unknown__":{"properties":{"meta":{"properties":{"maxResults":{"type":"number","format":"double"}},"required":["maxResults"],"type":"object"},"items":{"items":{"$ref":"#/components/schemas/Record_string.unknown_"},"type":"array"}},"required":["meta","items"],"type":"object"},"TeamMemberListResponse":{"$ref":"#/components/schemas/ListResponse_Record_string.unknown__"},"FeedPost":{"$ref":"#/components/schemas/Record_string.unknown_"},"ListResponse_FeedPost_":{"properties":{"meta":{"properties":{"maxResults":{"type":"number","format":"double"}},"required":["maxResults"],"type":"object"},"items":{"items":{"$ref":"#/components/schemas/FeedPost"},"type":"array"}},"required":["meta","items"],"type":"object"},"FeedPostListResponse":{"$ref":"#/components/schemas/ListResponse_FeedPost_"},"ProductCollection":{"properties":{"collectionTitle":{"type":"string"},"id":{"type":"string"}},"required":["collectionTitle","id"],"type":"object"},"Product":{"properties":{"customProperties":{"$ref":"#/components/schemas/Record_string.unknown_"},"collections":{"items":{"$ref":"#/components/schemas/ProductCollection"},"type":"array"},"externalId":{"type":"string","nullable":true},"tags":{"items":{"type":"string"},"type":"array"},"isForSale":{"type":"boolean","nullable":true},"currency":{"type":"string","nullable":true},"originalPrice":{"type":"number","format":"double","nullable":true},"price":{"type":"number","format":"double","nullable":true},"imageUrl":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"vendor":{"type":"string","nullable":true},"handle":{"type":"string","nullable":true},"bodyHtml":{"type":"string","nullable":true},"type":{"type":"string"},"title":{"type":"string"},"id":{"type":"string"}},"required":["collections","externalId","tags","isForSale","currency","originalPrice","price","imageUrl","url","status","vendor","handle","bodyHtml","type","title","id"],"type":"object"},"ListResponse_Product_":{"properties":{"meta":{"properties":{"maxResults":{"type":"number","format":"double"}},"required":["maxResults"],"type":"object"},"items":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"required":["meta","items"],"type":"object"},"ProductListResponse":{"$ref":"#/components/schemas/ListResponse_Product_"},"Collection":{"properties":{"updated":{"type":"string"},"created":{"type":"string"},"externalId":{"type":"string"},"bodyHtml":{"type":"string"},"handle":{"type":"string"},"title":{"type":"string"},"feedId":{"type":"string"},"id":{"type":"string"}},"required":["updated","created","externalId","bodyHtml","handle","title","feedId","id"],"type":"object"},"ListResponse_Collection_":{"properties":{"meta":{"properties":{"maxResults":{"type":"number","format":"double"}},"required":["maxResults"],"type":"object"},"items":{"items":{"$ref":"#/components/schemas/Collection"},"type":"array"}},"required":["meta","items"],"type":"object"},"CollectionListResponse":{"$ref":"#/components/schemas/ListResponse_Collection_"},"UpsertResponse":{"properties":{"id":{"type":"string"}},"required":["id"],"type":"object"},"Record_string.string-or-number-or-Record_string.unknown_-or-string-Array-or-number-Array_":{"properties":{},"additionalProperties":{"anyOf":[{"type":"string"},{"type":"number","format":"double"},{"$ref":"#/components/schemas/Record_string.unknown_"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"number","format":"double"},"type":"array"}]},"type":"object","description":"Construct a type with a set of properties K of type T"},"CustomProperties":{"$ref":"#/components/schemas/Record_string.string-or-number-or-Record_string.unknown_-or-string-Array-or-number-Array_"},"UpsertProductRequest":{"properties":{"customProperties":{"$ref":"#/components/schemas/CustomProperties"},"externalCollectionIds":{"items":{"type":"string"},"type":"array"},"collectionIds":{"items":{"type":"string"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"isForSale":{"type":"boolean"},"currency":{"type":"string"},"originalPrice":{"type":"number","format":"double"},"price":{"type":"number","format":"double"},"imageUrl":{"type":"string"},"url":{"type":"string"},"source":{"type":"string"},"vendor":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"handle":{"type":"string"},"bodyHtml":{"type":"string"},"title":{"type":"string"},"externalId":{"type":"string"},"id":{"type":"string"}},"type":"object"},"UpsertCollectionRequest":{"properties":{"customProperties":{"$ref":"#/components/schemas/CustomProperties"},"source":{"type":"string"},"handle":{"type":"string"},"bodyHtml":{"type":"string"},"externalId":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"}},"required":["title"],"type":"object"},"PostRequestResponse":{"properties":{"body":{"properties":{"requestId":{"type":"string"}},"required":["requestId"],"type":"object"},"state":{"type":"string"}},"required":["body","state"],"type":"object"},"PostButton":{"properties":{"url":{"type":"string"},"text":{"type":"string"}},"required":["url","text"],"type":"object"},"PostAuthor":{"properties":{"image":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"bio":{"type":"string"},"name":{"type":"string"},"userId":{"type":"string"}},"type":"object"},"PostRecipients":{"properties":{"isPostPrivate":{"type":"boolean"},"contactId":{"type":"string"}},"type":"object"},"PostCtaLink":{"properties":{"fileName":{"type":"string"},"url":{"type":"string"},"title":{"type":"string"}},"required":["url","title"],"type":"object"},"PostNotificationSettings":{"properties":{"rejectedStatusTag":{"type":"string"},"targetedStatusTag":{"type":"string"},"rejectedTag":{"type":"string"},"targetedTag":{"type":"string"},"postDescription":{"type":"string"},"postTitle":{"type":"string"},"notificationText":{"type":"string"},"deliveryMode":{"type":"string","enum":["user_preference","force_email","force_sms","force_email_and_sms"]},"notifyInactiveFollowers":{"type":"boolean"},"notify":{"type":"boolean"},"showFullPostInEmail":{"type":"boolean"}},"type":"object"},"CreatePostRequest":{"properties":{"imageUrl":{"type":"string"},"notificationSettings":{"$ref":"#/components/schemas/PostNotificationSettings"},"ctaLink":{"$ref":"#/components/schemas/PostCtaLink"},"publishDate":{"type":"string"},"action":{"type":"string","enum":["publish","schedule","suggest"]},"mediaImageUrls":{"items":{"type":"string"},"type":"array"},"recipients":{"$ref":"#/components/schemas/PostRecipients"},"author":{"$ref":"#/components/schemas/PostAuthor"},"button":{"$ref":"#/components/schemas/PostButton"},"text":{"type":"string"},"header":{"type":"string"}},"type":"object"},"FeedsResponse":{"$ref":"#/components/schemas/ListResponse_Record_string.unknown__"},"ContactListResponse":{"$ref":"#/components/schemas/ListResponse_Record_string.unknown__"},"CreatedContact":{"properties":{"state":{"type":"string"},"image":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"id":{"type":"string"}},"required":["state","image","email","phone","name","id"],"type":"object"},"Record_string.Record_string.unknown__":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/Record_string.unknown_"},"type":"object","description":"Construct a type with a set of properties K of type T"},"NotificationPreferences":{"properties":{"email":{"type":"string"},"sms":{"type":"string"}},"type":"object"},"CreateContactRequest":{"properties":{"notificationSettings":{"type":"string","enum":["always","only_new","off"]},"systemSource":{"type":"string","enum":["kvass","shopify","webhook","api","webmegler","core","vitec_next","list_import","direct","meta","google"]},"customMessage":{"type":"string"},"follows":{"$ref":"#/components/schemas/NotificationPreferences"},"region":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"bio":{"type":"string"},"image":{"type":"string"},"statusTags":{"$ref":"#/components/schemas/Record_string.Record_string.unknown__"},"tags":{"items":{"type":"string"},"type":"array"},"useEmailByDefault":{"type":"boolean"},"addDirectly":{"type":"boolean"},"source":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"}},"type":"object"},"UpdateContactTagsRequest":{"properties":{"tagsToRemove":{"items":{"type":"string"},"type":"array"},"tagsToAdd":{"items":{"type":"string"},"type":"array"}},"type":"object"},"BasicContact":{"properties":{"phone":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"state":{"type":"string"},"feedId":{"type":"string"},"id":{"type":"string"}},"required":["phone","image","email","name","state","feedId","id"],"type":"object"},"UpdateNotificationSettingsRequest":{"properties":{"email":{"type":"boolean"},"sms":{"type":"boolean"}},"type":"object"},"EmbeddedIntegration":{"properties":{"created":{"type":"string"},"feedIds":{"items":{"type":"string"},"type":"array"},"id":{"type":"string"}},"required":["created","feedIds","id"],"type":"object"},"Record_string.string_":{"properties":{},"additionalProperties":{"type":"string"},"type":"object","description":"Construct a type with a set of properties K of type T"},"Permissions":{"$ref":"#/components/schemas/Record_string.string_"},"AuthorizationResponse":{"properties":{"permissions":{"$ref":"#/components/schemas/Permissions"},"feed":{"properties":{"name":{"type":"string"},"id":{"type":"string"}},"required":["name","id"],"type":"object"},"organization":{"properties":{"name":{"type":"string"},"id":{"type":"string"}},"required":["name","id"],"type":"object"},"status":{"type":"string"}},"required":["status"],"type":"object"}},"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key"}}},"info":{"title":"Knips Public API","version":"1.0.0","description":"Public API for Knips.","license":{"name":"MIT"},"contact":{"name":"unknown"}},"paths":{"/feeds/{feedId}/team-members":{"get":{"operationId":"ListTeamMembers","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamMemberListResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns the publicly listed team members of a workspace. Secret team\nmembers are not included.","tags":["Team members"],"security":[{"apiKey":["feeds:read-only"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}}]}},"/feeds/{feedId}/posts":{"get":{"operationId":"GetFeedPosts","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedPostListResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns the published, public posts in a workspace. These posts power public\nembeds, so no API key is required. Use $offset and $limit to paginate\n($limit is capped at 30 and $offset at 100), $filter to narrow the\nresult set and $orderBy to sort.","tags":["Posts"],"security":[],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}},{"in":"query","name":"$offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"$limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"in":"query","name":"$orderBy","required":false,"schema":{"type":"string"}}]}},"/feeds/{feedId}/public-posts":{"get":{"operationId":"GetEmbeddablePosts","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PublicPost"},"type":"array"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns a lightweight summary of the public posts in a workspace, intended\nfor embedding on websites. No API key is required. Use limit to cap the\nresult (defaults to 10, maximum 30).","tags":["Posts"],"security":[],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"format":"double","type":"number"}}]}},"/feeds/{feedId}/products":{"get":{"operationId":"ListProducts","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns the products in a workspace. Use $offset and $limit to paginate, and\n$filter to narrow the result set.","tags":["Workspace Products"],"security":[{"apiKey":["products:read-only"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}},{"in":"query","name":"$offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"$limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"$filter","required":false,"schema":{"type":"string"}}]},"post":{"operationId":"UpsertProduct","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Creates a product, or updates the existing one when a matching id or\nexternalId is found in the workspace.","tags":["Workspace Products"],"security":[{"apiKey":["products:read-write"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertProductRequest"}}}}}},"/feeds/{feedId}/collections":{"get":{"operationId":"ListCollections","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionListResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns the collections in a workspace. Use $offset and $limit to paginate, and\n$filter to narrow the result set.","tags":["Workspace Products"],"security":[{"apiKey":["products:read-only"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}},{"in":"query","name":"$offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"$limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"$filter","required":false,"schema":{"type":"string"}}]},"post":{"operationId":"UpsertCollection","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Creates a collection, or updates the existing one when a matching id or\nexternalId is found in the workspace.","tags":["Workspace Products"],"security":[{"apiKey":["products:read-write"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertCollectionRequest"}}}}}},"/feeds/{feedId}/post-requests":{"post":{"operationId":"CreatePostRequest","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRequestResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Requests creation of a new post in a workspace. The action field controls\nwhether it is published, scheduled or suggested.","tags":["Posts"],"security":[{"apiKey":["posts:read-write"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePostRequest"}}}}}},"/feeds":{"get":{"operationId":"List","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedsResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns the workspaces in the organisation.","tags":["Workspaces"],"security":[{"apiKey":["feeds:read-only"]}],"parameters":[{"in":"query","name":"$offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"$limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"in":"query","name":"$orderBy","required":false,"schema":{"type":"string"}}]}},"/feeds/{feedId}/contacts":{"get":{"operationId":"ListContacts","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactListResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns the contacts in a workspace. Use $offset and $limit to paginate, and\n$filter / $orderBy to narrow and sort the result set. Set the Accept\nheader to text/csv or the xlsx MIME type to download the contacts as a\nspreadsheet instead.","tags":["Contacts"],"security":[{"apiKey":["contacts:read-only"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}},{"in":"query","name":"$offset","required":false,"schema":{"type":"string"}},{"in":"query","name":"$limit","required":false,"schema":{"type":"string"}},{"in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"in":"query","name":"$orderBy","required":false,"schema":{"type":"string"}}]},"post":{"operationId":"CreateContact","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedContact"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Creates a contact in a workspace.","tags":["Contacts"],"security":[{"apiKey":["feeds:read-write"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactRequest"}}}}}},"/feeds/{feedId}/contacts/contacts-tags":{"get":{"operationId":"ListContactTags","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Record_string.unknown_"},"type":"array"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Returns the contact tags used in a workspace.","tags":["Contacts"],"security":[{"apiKey":["contacts:read-only"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}}]}},"/feeds/{feedId}/contacts/{contactId}/tags":{"patch":{"operationId":"UpdateContactTags","responses":{"204":{"description":"No Content"},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Adds and/or removes tags on a single contact.","tags":["Contacts"],"security":[{"apiKey":["contacts:read-write"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}},{"in":"path","name":"contactId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactTagsRequest"}}}}}},"/feeds/{feedId}/contacts/{contactId}/notification-settings":{"patch":{"operationId":"UpdateNotificationSettings","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicContact"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Updates a contact's notification settings. Also activates the contact if it\nis not already active.","tags":["Contacts"],"security":[{"apiKey":["contacts:read-write"]}],"parameters":[{"in":"path","name":"feedId","required":true,"schema":{"type":"string"}},{"in":"path","name":"contactId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotificationSettingsRequest"}}}}}},"/authorization":{"get":{"operationId":"Authorize","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationResponse"}}}},"403":{"description":"The API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}},"404":{"description":"The workspace this key is scoped to does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorResponse"}}}}},"description":"Validates Basic authentication credentials and returns the organisation or workspace it is scoped to.","tags":["Authorization"],"security":[{"apiKey":[]}],"parameters":[]}}},"servers":[{"url":"/"}]}