> For the complete documentation index, see [llms.txt](https://docs.hos.accessacloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/workspace.md). # Workspace Api Methods for Workspace ## AddUser > Add User to an organisation. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Workspace","description":"Api Methods for Workspace"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"AddInviteUserRequest":{"type":"object","properties":{"OrganisationId":{"type":"string","nullable":true},"SubscriptionId":{"type":"string","nullable":true},"WorkspaceMemberID":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"FirstName":{"type":"string","nullable":true},"LastName":{"type":"string","nullable":true},"OrganisationRole":{"type":"string","description":"Role of the user within the organisation: it can be only Administrator or User."},"RoleName":{"type":"string","description":"Role of the user within the application(Example : Super User, Standard User)."},"SendInvite":{"type":"boolean","description":"If true, an email will be sent directly to the user to set his password and join the organisation."}}},"AddInviteUserResponse":{"type":"object","nullable":true,"properties":{"organisation":{"allOf":[{"$ref":"#/components/schemas/Organisation"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Organisation":{"type":"object","nullable":true,"properties":{"addUser":{"allOf":[{"$ref":"#/components/schemas/AddUser"}]},"inviteUser":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]},"setUserRole":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]},"importUser":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]},"setUserEmailAddress":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"AddUser":{"type":"object","nullable":true,"properties":{"addedUser":{"allOf":[{"$ref":"#/components/schemas/AddedUser"}]},"error":{"allOf":[{"$ref":"#/components/schemas/Error"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"AddedUser":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Error":{"type":"object","nullable":true,"properties":{"message":{"type":"string","nullable":true},"shouldRetry":{"description":"Arbitrary JSON value: source declares object; no fixed property contract is imposed."},"type":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"OrganisationMutationPayload":{"type":"object","nullable":true,"properties":{"error":{"allOf":[{"$ref":"#/components/schemas/Error"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/Workspace/AddUser":{"post":{"operationId":"WorkspaceAddUser","summary":"AddUser","tags":["Workspace"],"description":"Add User to an organisation.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddInviteUserRequest"}}}},"responses":{"200":{"description":"Source return path at pinned commit; runtime and deployed-version alignment unverified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddInviteUserResponse"}}}}}}}}} ``` ## InviteUser > Invite User by sending Email. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Workspace","description":"Api Methods for Workspace"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"AddInviteUserResponse":{"type":"object","nullable":true,"properties":{"organisation":{"allOf":[{"$ref":"#/components/schemas/Organisation"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Organisation":{"type":"object","nullable":true,"properties":{"addUser":{"allOf":[{"$ref":"#/components/schemas/AddUser"}]},"inviteUser":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]},"setUserRole":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]},"importUser":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]},"setUserEmailAddress":{"allOf":[{"$ref":"#/components/schemas/OrganisationMutationPayload"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"AddUser":{"type":"object","nullable":true,"properties":{"addedUser":{"allOf":[{"$ref":"#/components/schemas/AddedUser"}]},"error":{"allOf":[{"$ref":"#/components/schemas/Error"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"AddedUser":{"type":"object","nullable":true,"properties":{"id":{"type":"string","format":"uuid"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"Error":{"type":"object","nullable":true,"properties":{"message":{"type":"string","nullable":true},"shouldRetry":{"description":"Arbitrary JSON value: source declares object; no fixed property contract is imposed."},"type":{"type":"string","nullable":true}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."},"OrganisationMutationPayload":{"type":"object","nullable":true,"properties":{"error":{"allOf":[{"$ref":"#/components/schemas/Error"}]}},"description":"Source-backed JSON members, including inheritance and JSON naming/ignore attributes. No property is required solely because its CLR value type is non-nullable. Runtime and deployment alignment are unverified."}}},"paths":{"/Workspace/InviteUser":{"get":{"operationId":"WorkspaceInviteUser","summary":"InviteUser","tags":["Workspace"],"description":"Invite User by sending Email.","responses":{"200":{"description":"Source return path at pinned commit; runtime and deployed-version alignment unverified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddInviteUserResponse"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/workspace.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.