{"openapi":"3.0.3","info":{"title":"Orgnise API","description":"Streamline your work with our all-in-one knowledge, doc, and project management system.","version":"0.0.1","contact":{"name":"Orgnise Support","email":"orgnisehq@gmail.com","url":"http://docs.orgnise.in/api-reference/introduction"},"license":{"name":"AGPL-3.0 license","url":"https://github.com/Orgnise/webapp/blob/main/LICENSE.md"}},"servers":[{"url":"https://api.orgnise.in","description":"Production API"}],"x-speakeasy-globals":{"parameters":[{"x-speakeasy-globals-hidden":true,"name":"teamId","in":"query","required":true,"schema":{"type":"string"}}]},"paths":{"/teams":{"get":{"operationId":"getTeams","x-speakeasy-name-override":"list","summary":"Retrieve a list of team","description":"Retrieve a list of team for the authenticated user.","tags":["teams"],"security":[{"token":[]}],"responses":{"200":{"description":"A list of team","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TeamSchema"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"createTeam","x-speakeasy-name-override":"create","summary":"Create a team","description":"Create a new team for the authenticated user.","tags":["teams"],"security":[{"token":[]}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"slug":{"type":"string","minLength":3,"maxLength":48},"description":{"type":"string","maxLength":120}},"required":["name","slug"]}}}},"responses":{"200":{"description":"The created team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/teams/{team_slug}":{"get":{"operationId":"getTeamInfo","x-speakeasy-name-override":"get","summary":"Retrieve a team","description":"Retrieve a team for the authenticated user.","tags":["teams"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true}],"responses":{"200":{"description":"The retrieved team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"put":{"operationId":"updateTeam","summary":"update a team","description":"Update a team.","tags":["teams"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateTeamSchema"}}}},"responses":{"200":{"description":"The updated team","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/teams/{team_slug}/workspaces":{"post":{"operationId":"createWorkspace","x-speakeasy-name-override":"create","summary":"Create a workspace","description":"Create a new workspace. Workspaces are collections of projects and tasks. Workspaces can be private or public. Private workspaces are only visible to members of the workspace.","tags":["workspaces"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createWorkspaceSchema"}}}},"responses":{"200":{"description":"The created workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"get":{"operationId":"getWorkspaces","x-speakeasy-name-override":"list","summary":"Retrieve a list of workspace","description":"Retrieve a list of workspace for the authenticated user.","tags":["workspaces"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true}],"responses":{"200":{"description":"A list of workspace","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceSchema"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/teams/{team_slug}/workspaces/{workspace_slug}":{"get":{"operationId":"getWorkspaceInfo","x-speakeasy-name-override":"get","summary":"Retrieve a workspace","description":"Retrieve a workspace for the authenticated user.","tags":["workspaces"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true},{"in":"path","name":"workspace_slug","description":"The slug of the workspace.","schema":{"type":"string","description":"The slug of the workspace."},"required":true}],"responses":{"200":{"description":"The retrieved workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"put":{"operationId":"updateWorkspace","summary":"update a workspace","description":"Update a workspace.","tags":["workspaces"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true},{"in":"path","name":"workspace_slug","description":"The slug of the workspace.","schema":{"type":"string","description":"The slug of the workspace."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateWorkspaceSchema"}}}},"responses":{"200":{"description":"The updated workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"getWorkspaceInfo","summary":"Delete a workspace","description":"Delete a workspace of a team.","tags":["workspaces"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true},{"in":"path","name":"workspace_slug","description":"The slug of the workspace.","schema":{"type":"string","description":"The slug of the workspace."},"required":true}],"responses":{"200":{"description":"The deleted workspace","content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleteWorkspaceUserSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/collections":{"get":{"operationId":"getCollections","x-speakeasy-name-override":"list","summary":"Retrieve a list of collections","description":"Retrieve a list of collections of the workspace.","tags":["collections"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true},{"in":"path","name":"workspace_slug","description":"The slug of the workspace.","schema":{"type":"string","description":"The slug of the workspace."},"required":true}],"responses":{"200":{"description":"A list of collections","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CollectionSchema"}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"createCollection","x-speakeasy-name-override":"create","summary":"Create a collection/page","description":"Create a new collection. Collections group related pages together. A collection can have as many as sub-collection or pages as you want, allowing you to organize your content in a flexible way. ","tags":["collections"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true},{"in":"path","name":"workspace_slug","description":"The slug of the workspace.","schema":{"type":"string","description":"The slug of the workspace."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCollectionSchema"}}}},"responses":{"200":{"description":"The created collection/page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionSchema"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/collections/reorder":{"post":{"operationId":"reorderItem","summary":"Reorder a collection/page","description":"Reorder a collection/page within or outside a collection. This will change the order of the collection/page in the collection.","tags":["collections"],"security":[{"token":[]}],"parameters":[{"in":"path","name":"team_slug","description":"The slug of the team.","schema":{"type":"string","description":"The slug of the team."},"required":true},{"in":"path","name":"workspace_slug","description":"The slug of the workspace.","schema":{"type":"string","description":"The slug of the workspace."},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderCollectionSchema"}}}},"responses":{"200":{"description":"Reorder collection/page","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","default":""}},"required":["message"]}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"410":{"$ref":"#/components/responses/410"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"token":{"type":"http","description":"Default authentication mechanism","scheme":"bearer"}},"schemas":{"TeamSchema":{"type":"object","properties":{"_id":{"type":"string","description":"The unique ID of the team."},"name":{"type":"string","description":"The name of the team."},"logo":{"type":"string","nullable":true,"default":null,"description":"The logo of the team."},"description":{"type":"string","nullable":true,"maxLength":120,"description":"The description of the team."},"role":{"description":"The role of the authenticated user in the team."},"membersCount":{"type":"number","description":"The members count of the team."},"meta":{"type":"object","properties":{"title":{"type":"string","description":"The title of the team."},"description":{"type":"string","description":"The description of the team."},"slug":{"type":"string","description":"The slug of the team."}},"required":["title","description","slug"],"description":"The meta of the team."},"inviteCode":{"type":"string","maxLength":24,"description":"The invite code of the team."},"plan":{"type":"string","enum":["free","pro","business","enterprise"],"description":"The plan of the team."},"billingCycleStart":{"type":"number","description":"The date and time when the billing cycle starts for the team."},"usage":{"type":"object","properties":{"pages":{"type":"number","default":0,"description":"The limit of pages for the team"},"users":{"type":"number","default":0,"description":"The limit of users for the team"},"workspaces":{"type":"number","default":0,"description":"The limit of workspaces for the team"}},"required":["pages","users","workspaces"],"description":"The usage of the resource of a team."},"limit":{"type":"object","properties":{"pages":{"type":"number","default":0,"description":"The limit of pages for the team"},"users":{"type":"number","default":0,"description":"The limit of users for the team"},"workspaces":{"type":"number","default":0,"description":"The limit of workspaces for the team"}},"required":["pages","users","workspaces"],"description":"The limit of the team resources."},"createdAt":{"type":"string","description":"The date and time when the team was created."},"updatedAt":{"type":"string","description":"The date and time when the team was last updated."}},"required":["_id","name","logo","description","membersCount","meta","inviteCode","plan","billingCycleStart","usage","limit","createdAt","updatedAt"],"title":"team"},"WorkspaceSchema":{"type":"object","properties":{"_id":{"type":"string","description":"The unique ID of the workspace."},"name":{"type":"string","description":"The name of the workspace."},"description":{"type":"string","maxLength":120,"default":"","description":"The description of the workspace."},"defaultAccess":{"$ref":"#/components/schemas/defaultAccess"},"meta":{"type":"object","properties":{"title":{"type":"string","description":"The title of the workspace."},"description":{"type":"string","description":"The description of the workspace."},"slug":{"type":"string","description":"The slug of the workspace."}},"required":["title","description","slug"],"description":"The meta of the workspace."},"Visibility":{"$ref":"#/components/schemas/visibility"},"createdAt":{"type":"string","description":"The date and time when the workspace was created."},"updatedAt":{"type":"string","description":"The date and time when the workspace was last updated."}},"required":["_id","name","description","defaultAccess","meta","Visibility","createdAt","updatedAt"],"title":"workspace","description":"A workspace is a collection of projects and tasks. Workspaces can be private or public. Private workspaces are only visible to members of the workspace."},"CollectionSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the collection/page."},"name":{"type":"string","description":"The name of the collection/page."},"object":{"description":"Object describes the type of the collection. Collections will be of type 'collection' and pages will be of type 'item'."},"parent":{"type":"string","description":"The parent collection id."},"children":{"type":"array","items":{"type":"object"},"description":"The children of the collection."},"team":{"type":"string","description":"The team Id of the collection/page belongs to."},"content":{"type":"object","description":"The content of the page. This will be a JSON object. if the object is a collection, this will be empty."},"workspace":{"type":"string","description":"The workspace Id of the collection/page belongs to."},"meta":{"type":"object","properties":{"title":{"type":"string","description":"The title of the collection/page"},"slug":{"type":"string","description":"The slug of the collection/page."}},"required":["title","slug"],"description":"The meta of the team."},"createdAt":{"type":"string","description":"The date and time the collection/page was created."},"updatedAt":{"type":"string","description":"The date and time the collection/page was last updated."}},"required":["id","name","team","workspace","meta","createdAt","updatedAt"],"description":"A collection.","example":{"id":"1","name":"My Collection","object":"collection","createdAt":"2021-01-01T00:00:00.000Z","updatedAt":"2021-01-01T00:00:00.000Z","team":"some-team-id","workspace":"some-workspace-id","meta":{"title":"My Collection","slug":"my-collection"}}},"CreateCollectionSchema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"The name of the collection. It is optional and can be a maximum of 32 characters long."},"object":{"default":"collection","description":"The type of the collection. Collections can be of type 'collection' or 'item'."},"parent":{"type":"string","description":"The parent collection id."}},"description":"Create a new collection.","example":{"name":"My Collection","object":"collection"}},"InviteTeamMemberSchema":{"type":"object","properties":{"_id":{"type":"string","minLength":1,"description":"Id of the team member."},"email":{"type":"string","format":"email","minLength":1,"description":"Email of the team member."},"role":{"type":"string","enum":["guest","member","moderator","owner"],"description":"Role of the team member."},"expires":{"type":"string","description":"Date when the invite expires."},"createdAt":{"type":"string","description":"Date when the invite was sent"}},"required":["_id","email","role","expires","createdAt"],"description":"Invite team member schema.","example":{"_id":"1","email":"john@doe.com","createdAt":"2026-04-28T21:00:09.061Z","expires":"2026-04-28T21:00:09.061Z","role":"member"}},"ReorderCollectionSchema":{"type":"object","properties":{"id":{"type":"string","description":"The id of the collection/page to reorder."},"parent":{"type":"string","description":"The parent collection/page id."},"newParent":{"type":"string","description":"The new parent collection/page id."},"index":{"type":"number","description":"The index to move the collection to."},"object":{"description":"Object describes the type of the collection/page . Collections will be of type 'collection' and pages will be of type 'item'."}},"required":["id","index"],"description":"Reorder a collection/page.","example":{"id":"1","parent":"2","index":3,"object":"item"}},"SendInviteSchema":{"type":"object","properties":{"invites":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email","minLength":1,"description":"Email of the user to send the invite to."},"role":{"type":"string","enum":["guest","member","moderator","owner"],"description":"Role of the user to invite."}},"required":["email","role"]}}},"required":["invites"],"description":"Send invite to add them in team.","example":{"invites":[{"email":"john@doe.com","role":"member"}]}},"TeamInvitesSchema":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/InviteTeamMemberSchema"}}},"required":["users"]},"TeamMemberSchema":{"type":"object","properties":{"_id":{"type":"string","minLength":1,"description":"Id of the team member."},"name":{"type":"string","minLength":1,"description":"Name of the team member."},"email":{"type":"string","format":"email","minLength":1,"description":"Email of the team member."},"image":{"type":"string","description":"Image URL of the team member."},"role":{"type":"string","enum":["guest","member","moderator","owner"],"description":"Role of the team member."}},"required":["_id","name","email","role"],"description":"A team member.","example":{"_id":"60f4e6f5b0a3d2001f4d8a7d","name":"John Doe","email":"john@doe.com","role":"member","image":"https://example.com/image.jpg"}},"TeamUsersListSchema":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/TeamMemberSchema"}}},"required":["users"],"description":"List of team members."},"UpdateCollectionSchema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"The name of the collection. It is optional and can be a maximum of 32 characters long."},"parent":{"type":"string","description":"The parent collection id."}},"description":"Update a collection.","example":{"name":"My updated Collection"}},"addWorkspaceMemberSchema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The ID of the user to add to the workspace."},"role":{"type":"string","enum":["editor","reader"],"description":"The role of the user in the workspace."}},"required":["email","role"]},"title":"Add Workspace Member","description":"Add a user to a workspace. Users can have the role of editor or reader.","example":[{"email":"jondoe@gmail.com","role":"editor"}]},"createWorkspaceSchema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"The name of the workspace."},"description":{"type":"string","maxLength":120,"default":"","description":"The description of the workspace."},"visibility":{"$ref":"#/components/schemas/visibility"},"defaultAccess":{"$ref":"#/components/schemas/defaultAccess"}},"required":["name"],"title":"Create Workspace","description":"Create a new workspace. Workspaces are collections of projects and tasks. Workspaces can be private or public. Private workspaces are only visible to members of the workspace.","example":{"name":"Engineering Workspace","description":"A workspace for the engineering team.","visibility":"public","defaultAccess":"full"}},"deleteWorkspaceUserSchema":{"type":"object","properties":{"message":{"type":"string","default":""}},"required":["message"]},"removeUserFromTeamSchema":{"type":"object","properties":{"userId":{"type":"string","minLength":1,"description":"User Id of the user to remove from the team."}},"required":["userId"],"description":"Remove a member from a team.","example":{"userId":"60f4e6f5b0a3d2001f4d8a7d"}},"updateTeamSchema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32},"description":{"type":"string","maxLength":120},"slug":{"type":"string","minLength":3,"maxLength":48}},"title":"Update Team","description":"Update a team.","example":{"name":"Engineering Team","description":"A team for the engineering department.","slug":"engineering"}},"removeWorkspaceUserSchema":{"type":"object","properties":{"userId":{"type":"string","minLength":1}},"required":["userId"],"title":"Remove Workspace User","description":"Remove a user from a workspace.","example":{"userId":"60f1a3c7d6d1e3e9b0b1b6f3"}},"updateUserInTeamRoleSchema":{"type":"object","properties":{"userId":{"type":"string","minLength":1,"description":"User Id of the user to update."},"role":{"type":"string","enum":["guest","member","moderator","owner"],"description":"Role to update the user to. Must be one of guest, member, moderator, owner."}},"required":["userId","role"],"description":"Update a user's role for a specific team.","example":{"userId":"60f4e6f5b0a3d2001f4d8a7d","role":"member"}},"updateWorkspaceRoleSchema":{"type":"object","properties":{"userId":{"type":"string","minLength":1},"role":{"type":"string","enum":["editor","reader"]}},"required":["userId","role"],"title":"Update Workspace Role","description":"Update the role of a user in a workspace. Users can have the role of editor or reader.","example":{"userId":"60f1a3c7d6d1e3e9b0b1b6f3","role":"editor"}},"updateWorkspaceSchema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":32,"description":"The name of the workspace."},"description":{"type":"string","maxLength":120,"description":"The description of the workspace."},"slug":{"type":"string","minLength":3,"maxLength":48,"description":"The slug of the workspace."},"visibility":{"$ref":"#/components/schemas/visibility"},"defaultAccess":{"$ref":"#/components/schemas/defaultAccess"}},"title":"Update Workspace","description":"Update a workspace. Workspaces are collections of projects and tasks. Workspaces can be private or public. Private workspaces are only visible to members of the workspace.","example":{"name":"Engineering Workspace","description":"A workspace for the engineering team.","visibility":"public","defaultAccess":"full"}},"visibility":{"default":"public","description":"The visibility of the workspace. Private workspaces are only visible to members of the workspace.","example":"public"},"defaultAccess":{"type":"string","enum":["full","read-only"],"default":"full","description":"The default access level of the workspace. Full access allows members to perform all actions in the workspace. Read access allows members to view the workspace but not make changes.","example":"full"}},"responses":{"400":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"x-speakeasy-name-override":"BadRequest","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request"],"description":"A short code indicating the error code returned.","example":"bad_request"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#bad_request"}},"required":["code","message"]}},"required":["error"]}}}},"401":{"description":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Unauthorized","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized"],"description":"A short code indicating the error code returned.","example":"unauthorized"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#unauthorized"}},"required":["code","message"]}},"required":["error"]}}}},"403":{"description":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Forbidden","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden"],"description":"A short code indicating the error code returned.","example":"forbidden"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#forbidden"}},"required":["code","message"]}},"required":["error"]}}}},"404":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"NotFound","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["not_found"],"description":"A short code indicating the error code returned.","example":"not_found"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#not_found"}},"required":["code","message"]}},"required":["error"]}}}},"409":{"description":"This response is sent when a request conflicts with the current state of the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Conflict","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["conflict"],"description":"A short code indicating the error code returned.","example":"conflict"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#conflict"}},"required":["code","message"]}},"required":["error"]}}}},"410":{"description":"This response is sent when the requested content has been permanently deleted from server, with no forwarding address.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InviteExpired","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invite_expired"],"description":"A short code indicating the error code returned.","example":"invite_expired"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#invite_expired"}},"required":["code","message"]}},"required":["error"]}}}},"422":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"UnprocessableEntity","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unprocessable_entity"],"description":"A short code indicating the error code returned.","example":"unprocessable_entity"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#unprocessable_entity"}},"required":["code","message"]}},"required":["error"]}}}},"429":{"description":"The user has sent too many requests in a given amount of time (\"rate limiting\")","content":{"application/json":{"schema":{"x-speakeasy-name-override":"RateLimitExceeded","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"],"description":"A short code indicating the error code returned.","example":"rate_limit_exceeded"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#rate_limit_exceeded"}},"required":["code","message"]}},"required":["error"]}}}},"500":{"description":"The server has encountered a situation it does not know how to handle.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InternalServerError","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["internal_server_error"],"description":"A short code indicating the error code returned.","example":"internal_server_error"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found."},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.orgnise.in/api-reference/errors#internal_server_error"}},"required":["code","message"]}},"required":["error"]}}}}}}}