> 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/company.md).

# Company

Api Methods for Company

## AddComment

> Adds the supplied comment to the company/household identified by CtcCpyID. The action returns a bodyless Ok result on its success path, not the submitted note or an invented response envelope. This writes data; confirmation of replay/idempotency behaviour is required before automated retries.

```json
{"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Company","description":"Api Methods for Company"}],"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 <token>`. See the Authorisation guide."}},"schemas":{"CtcCpyNotes":{"type":"object","nullable":true,"properties":{"Comment":{"type":"string","nullable":true,"description":"Comment Text"},"CtcCpyID":{"type":"integer","format":"int32","description":"Contact ID"},"NoteUserID":{"type":"integer","format":"int32"},"SourceNote":{"type":"integer","format":"int32"},"LastModifiedBy":{"type":"string","nullable":true},"LastModifiedOn":{"type":"string","format":"date-time"},"AttachmentFilesList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CtcCpyNotesAttachment"}},"AttachmentFilesListString":{"type":"array","nullable":true,"items":{"type":"string","nullable":true}}},"description":"Source-backed note model; individual actions may use only a subset of these members. No property presence is inferred solely from CLR types."},"CtcCpyNotesAttachment":{"type":"object","nullable":true,"properties":{"<AttachmentName>k__BackingField":{"type":"string","nullable":true},"<AttachmentID>k__BackingField":{"type":"string","nullable":true},"<FileName>k__BackingField":{"type":"string","nullable":true},"<FileContent>k__BackingField":{"type":"string","nullable":true},"<ContentType>k__BackingField":{"type":"string","nullable":true},"<FileSize>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<ID>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<HasContent>k__BackingField":{"type":"boolean"}},"description":"The nested Atreemo.Models.CtcCpyNotes.Attachment class is Serializable. The ordinary Web API formatter therefore exposes compiler backing-field names, not the property names used by a default Json.NET resolver. Runtime-unverified."}}},"paths":{"/api/Company/AddComment":{"post":{"operationId":"CompanyAddComment","summary":"AddComment","tags":["Company"],"description":"Adds the supplied comment to the company/household identified by CtcCpyID. The action returns a bodyless Ok result on its success path, not the submitted note or an invented response envelope. This writes data; confirmation of replay/idempotency behaviour is required before automated retries.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CtcCpyNotes"}}}},"responses":{"200":{"description":"No response body: the pinned action returns Ok() without content. Runtime-unverified. This truthful bodyless contract requires an owner decision against the repository blanket response-model rule."}}}}}}
```

## DeleteCompany

> Delete an existing Household/Company by its CpyID

```json
{"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Company","description":"Api Methods for Company"}],"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 <token>`. See the Authorisation guide."}}},"paths":{"/api/Company/DeleteCompany/{cpyId}":{"delete":{"operationId":"CompanyDeleteCompany","summary":"DeleteCompany","tags":["Company"],"description":"Delete an existing Household/Company by its CpyID","parameters":[{"name":"cpyId","in":"path","schema":{"type":"integer","format":"int32"},"required":true,"description":"Native path parameter. CLR int id in the pinned controller signature. The OpenAPI placeholder names the catalogue path segment; the CLR parameter is id."}],"responses":{"200":{"description":"No response body: the pinned action returns Ok() without content. Runtime-unverified. This truthful bodyless contract requires an owner decision against the repository blanket response-model rule."}}}}}}
```

## Get

> Search the database for one Household/Company using its CpyID

```json
{"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Company","description":"Api Methods for Company"}],"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 <token>`. See the Authorisation guide."}},"schemas":{"Company":{"type":"object","nullable":true,"description":"Source-backed JSON members. IgnoreDataMember members are omitted even when the controller populates them. CpyNotes is a virtual CtcCpyNotes property, not a CLR type named virtual. No required property presence is inferred from CLR types.","properties":{"Building":{"type":"string","nullable":true,"description":"Address 1"},"City":{"type":"string","nullable":true,"description":"City"},"CpyID":{"type":"integer","format":"int32","description":"Houshold ID in B2C intance Company ID in B2B intance"},"Name":{"type":"string","nullable":true,"description":"Houshold name in B2C intance Company name in B2B intance"},"PostCode":{"type":"string","nullable":true,"description":"Postcode"},"StateCode":{"type":"string","nullable":true,"description":"StateCode"},"StateName":{"type":"string","nullable":true,"description":"County"},"Street":{"type":"string","nullable":true,"description":"Address 2"},"Zone":{"type":"string","nullable":true,"description":"Address 3"},"CountryCode":{"type":"string","nullable":true,"description":"Country code; source documentation describes two-character values."},"CountryName":{"type":"string","nullable":true},"Phone":{"type":"string","nullable":true},"Fax":{"type":"string","nullable":true},"Web":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"NationalID":{"type":"string","nullable":true},"SourceID":{"type":"string","nullable":true},"OriginID":{"type":"string","nullable":true},"CreateDate":{"type":"string","format":"date-time","nullable":true},"LastModifDate":{"type":"string","format":"date-time","nullable":true},"ModifiedBy":{"type":"integer","format":"int32","nullable":true},"CpyNotes":{"allOf":[{"$ref":"#/components/schemas/CtcCpyNotes"}]},"SupInfo":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SupInfo"}}}},"CtcCpyNotes":{"type":"object","nullable":true,"properties":{"Comment":{"type":"string","nullable":true,"description":"Comment Text"},"CtcCpyID":{"type":"integer","format":"int32","description":"Contact ID"},"NoteUserID":{"type":"integer","format":"int32"},"SourceNote":{"type":"integer","format":"int32"},"LastModifiedBy":{"type":"string","nullable":true},"LastModifiedOn":{"type":"string","format":"date-time"},"AttachmentFilesList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CtcCpyNotesAttachment"}},"AttachmentFilesListString":{"type":"array","nullable":true,"items":{"type":"string","nullable":true}}},"description":"Source-backed note model; individual actions may use only a subset of these members. No property presence is inferred solely from CLR types."},"CtcCpyNotesAttachment":{"type":"object","nullable":true,"properties":{"<AttachmentName>k__BackingField":{"type":"string","nullable":true},"<AttachmentID>k__BackingField":{"type":"string","nullable":true},"<FileName>k__BackingField":{"type":"string","nullable":true},"<FileContent>k__BackingField":{"type":"string","nullable":true},"<ContentType>k__BackingField":{"type":"string","nullable":true},"<FileSize>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<ID>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<HasContent>k__BackingField":{"type":"boolean"}},"description":"The nested Atreemo.Models.CtcCpyNotes.Attachment class is Serializable. The ordinary Web API formatter therefore exposes compiler backing-field names, not the property names used by a default Json.NET resolver. Runtime-unverified."},"SupInfo":{"type":"object","nullable":true,"properties":{"FieldContent":{"type":"string","nullable":true,"description":"Field value"},"FieldName":{"type":"string","nullable":true,"description":"Field name"}}}}},"paths":{"/api/Company/Get/{cpyId}":{"get":{"operationId":"CompanyGet","summary":"Get","tags":["Company"],"description":"Search the database for one Household/Company using its CpyID","parameters":[{"name":"cpyId","in":"path","schema":{"type":"integer","format":"int32"},"required":true,"description":"Native path parameter. CLR int id in the pinned controller signature. The OpenAPI placeholder names the catalogue path segment; the CLR parameter is id."}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}}}}
```

## GetCompanies

> Search the database for Households/Companies using the Full Text Search engine

```json
{"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Company","description":"Api Methods for Company"}],"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 <token>`. See the Authorisation guide."}},"schemas":{"CompanyList":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"Company":{"type":"object","nullable":true,"description":"Source-backed JSON members. IgnoreDataMember members are omitted even when the controller populates them. CpyNotes is a virtual CtcCpyNotes property, not a CLR type named virtual. No required property presence is inferred from CLR types.","properties":{"Building":{"type":"string","nullable":true,"description":"Address 1"},"City":{"type":"string","nullable":true,"description":"City"},"CpyID":{"type":"integer","format":"int32","description":"Houshold ID in B2C intance Company ID in B2B intance"},"Name":{"type":"string","nullable":true,"description":"Houshold name in B2C intance Company name in B2B intance"},"PostCode":{"type":"string","nullable":true,"description":"Postcode"},"StateCode":{"type":"string","nullable":true,"description":"StateCode"},"StateName":{"type":"string","nullable":true,"description":"County"},"Street":{"type":"string","nullable":true,"description":"Address 2"},"Zone":{"type":"string","nullable":true,"description":"Address 3"},"CountryCode":{"type":"string","nullable":true,"description":"Country code; source documentation describes two-character values."},"CountryName":{"type":"string","nullable":true},"Phone":{"type":"string","nullable":true},"Fax":{"type":"string","nullable":true},"Web":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"NationalID":{"type":"string","nullable":true},"SourceID":{"type":"string","nullable":true},"OriginID":{"type":"string","nullable":true},"CreateDate":{"type":"string","format":"date-time","nullable":true},"LastModifDate":{"type":"string","format":"date-time","nullable":true},"ModifiedBy":{"type":"integer","format":"int32","nullable":true},"CpyNotes":{"allOf":[{"$ref":"#/components/schemas/CtcCpyNotes"}]},"SupInfo":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SupInfo"}}}},"CtcCpyNotes":{"type":"object","nullable":true,"properties":{"Comment":{"type":"string","nullable":true,"description":"Comment Text"},"CtcCpyID":{"type":"integer","format":"int32","description":"Contact ID"},"NoteUserID":{"type":"integer","format":"int32"},"SourceNote":{"type":"integer","format":"int32"},"LastModifiedBy":{"type":"string","nullable":true},"LastModifiedOn":{"type":"string","format":"date-time"},"AttachmentFilesList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CtcCpyNotesAttachment"}},"AttachmentFilesListString":{"type":"array","nullable":true,"items":{"type":"string","nullable":true}}},"description":"Source-backed note model; individual actions may use only a subset of these members. No property presence is inferred solely from CLR types."},"CtcCpyNotesAttachment":{"type":"object","nullable":true,"properties":{"<AttachmentName>k__BackingField":{"type":"string","nullable":true},"<AttachmentID>k__BackingField":{"type":"string","nullable":true},"<FileName>k__BackingField":{"type":"string","nullable":true},"<FileContent>k__BackingField":{"type":"string","nullable":true},"<ContentType>k__BackingField":{"type":"string","nullable":true},"<FileSize>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<ID>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<HasContent>k__BackingField":{"type":"boolean"}},"description":"The nested Atreemo.Models.CtcCpyNotes.Attachment class is Serializable. The ordinary Web API formatter therefore exposes compiler backing-field names, not the property names used by a default Json.NET resolver. Runtime-unverified."},"SupInfo":{"type":"object","nullable":true,"properties":{"FieldContent":{"type":"string","nullable":true,"description":"Field value"},"FieldName":{"type":"string","nullable":true,"description":"Field name"}}}}},"paths":{"/api/Company/GetCompanies":{"get":{"operationId":"CompanyGetCompanies","summary":"GetCompanies","tags":["Company"],"description":"Search the database for Households/Companies using the Full Text Search engine","parameters":[{"name":"criteria","in":"query","schema":{"type":"string","nullable":true},"description":"Native query parameter. CLR string criteria in the pinned controller signature.","required":true}],"responses":{"200":{"description":"Source return path at pinned commit; runtime and deployed-version alignment unverified.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyList"}}}}}}}}}
```

## PostCompany

> Add a new Household/Company The Household/Company will not be added if it matches an existing one.

```json
{"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Company","description":"Api Methods for Company"}],"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 <token>`. See the Authorisation guide."}},"schemas":{"Company":{"type":"object","nullable":true,"description":"Source-backed JSON members. IgnoreDataMember members are omitted even when the controller populates them. CpyNotes is a virtual CtcCpyNotes property, not a CLR type named virtual. No required property presence is inferred from CLR types.","properties":{"Building":{"type":"string","nullable":true,"description":"Address 1"},"City":{"type":"string","nullable":true,"description":"City"},"CpyID":{"type":"integer","format":"int32","description":"Houshold ID in B2C intance Company ID in B2B intance"},"Name":{"type":"string","nullable":true,"description":"Houshold name in B2C intance Company name in B2B intance"},"PostCode":{"type":"string","nullable":true,"description":"Postcode"},"StateCode":{"type":"string","nullable":true,"description":"StateCode"},"StateName":{"type":"string","nullable":true,"description":"County"},"Street":{"type":"string","nullable":true,"description":"Address 2"},"Zone":{"type":"string","nullable":true,"description":"Address 3"},"CountryCode":{"type":"string","nullable":true,"description":"Country code; source documentation describes two-character values."},"CountryName":{"type":"string","nullable":true},"Phone":{"type":"string","nullable":true},"Fax":{"type":"string","nullable":true},"Web":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"NationalID":{"type":"string","nullable":true},"SourceID":{"type":"string","nullable":true},"OriginID":{"type":"string","nullable":true},"CreateDate":{"type":"string","format":"date-time","nullable":true},"LastModifDate":{"type":"string","format":"date-time","nullable":true},"ModifiedBy":{"type":"integer","format":"int32","nullable":true},"CpyNotes":{"allOf":[{"$ref":"#/components/schemas/CtcCpyNotes"}]},"SupInfo":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SupInfo"}}}},"CtcCpyNotes":{"type":"object","nullable":true,"properties":{"Comment":{"type":"string","nullable":true,"description":"Comment Text"},"CtcCpyID":{"type":"integer","format":"int32","description":"Contact ID"},"NoteUserID":{"type":"integer","format":"int32"},"SourceNote":{"type":"integer","format":"int32"},"LastModifiedBy":{"type":"string","nullable":true},"LastModifiedOn":{"type":"string","format":"date-time"},"AttachmentFilesList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CtcCpyNotesAttachment"}},"AttachmentFilesListString":{"type":"array","nullable":true,"items":{"type":"string","nullable":true}}},"description":"Source-backed note model; individual actions may use only a subset of these members. No property presence is inferred solely from CLR types."},"CtcCpyNotesAttachment":{"type":"object","nullable":true,"properties":{"<AttachmentName>k__BackingField":{"type":"string","nullable":true},"<AttachmentID>k__BackingField":{"type":"string","nullable":true},"<FileName>k__BackingField":{"type":"string","nullable":true},"<FileContent>k__BackingField":{"type":"string","nullable":true},"<ContentType>k__BackingField":{"type":"string","nullable":true},"<FileSize>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<ID>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<HasContent>k__BackingField":{"type":"boolean"}},"description":"The nested Atreemo.Models.CtcCpyNotes.Attachment class is Serializable. The ordinary Web API formatter therefore exposes compiler backing-field names, not the property names used by a default Json.NET resolver. Runtime-unverified."},"SupInfo":{"type":"object","nullable":true,"properties":{"FieldContent":{"type":"string","nullable":true,"description":"Field value"},"FieldName":{"type":"string","nullable":true,"description":"Field name"}}}}},"paths":{"/api/Company/PostCompany":{"post":{"operationId":"CompanyPostCompany","summary":"PostCompany","tags":["Company"],"description":"Add a new Household/Company The Household/Company will not be added if it matches an existing one.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}}}}
```

## PutCompany

> Update an existing Household/Company

```json
{"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"Company","description":"Api Methods for Company"}],"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 <token>`. See the Authorisation guide."}},"schemas":{"Company":{"type":"object","nullable":true,"description":"Source-backed JSON members. IgnoreDataMember members are omitted even when the controller populates them. CpyNotes is a virtual CtcCpyNotes property, not a CLR type named virtual. No required property presence is inferred from CLR types.","properties":{"Building":{"type":"string","nullable":true,"description":"Address 1"},"City":{"type":"string","nullable":true,"description":"City"},"CpyID":{"type":"integer","format":"int32","description":"Houshold ID in B2C intance Company ID in B2B intance"},"Name":{"type":"string","nullable":true,"description":"Houshold name in B2C intance Company name in B2B intance"},"PostCode":{"type":"string","nullable":true,"description":"Postcode"},"StateCode":{"type":"string","nullable":true,"description":"StateCode"},"StateName":{"type":"string","nullable":true,"description":"County"},"Street":{"type":"string","nullable":true,"description":"Address 2"},"Zone":{"type":"string","nullable":true,"description":"Address 3"},"CountryCode":{"type":"string","nullable":true,"description":"Country code; source documentation describes two-character values."},"CountryName":{"type":"string","nullable":true},"Phone":{"type":"string","nullable":true},"Fax":{"type":"string","nullable":true},"Web":{"type":"string","nullable":true},"Email":{"type":"string","nullable":true},"NationalID":{"type":"string","nullable":true},"SourceID":{"type":"string","nullable":true},"OriginID":{"type":"string","nullable":true},"CreateDate":{"type":"string","format":"date-time","nullable":true},"LastModifDate":{"type":"string","format":"date-time","nullable":true},"ModifiedBy":{"type":"integer","format":"int32","nullable":true},"CpyNotes":{"allOf":[{"$ref":"#/components/schemas/CtcCpyNotes"}]},"SupInfo":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SupInfo"}}}},"CtcCpyNotes":{"type":"object","nullable":true,"properties":{"Comment":{"type":"string","nullable":true,"description":"Comment Text"},"CtcCpyID":{"type":"integer","format":"int32","description":"Contact ID"},"NoteUserID":{"type":"integer","format":"int32"},"SourceNote":{"type":"integer","format":"int32"},"LastModifiedBy":{"type":"string","nullable":true},"LastModifiedOn":{"type":"string","format":"date-time"},"AttachmentFilesList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CtcCpyNotesAttachment"}},"AttachmentFilesListString":{"type":"array","nullable":true,"items":{"type":"string","nullable":true}}},"description":"Source-backed note model; individual actions may use only a subset of these members. No property presence is inferred solely from CLR types."},"CtcCpyNotesAttachment":{"type":"object","nullable":true,"properties":{"<AttachmentName>k__BackingField":{"type":"string","nullable":true},"<AttachmentID>k__BackingField":{"type":"string","nullable":true},"<FileName>k__BackingField":{"type":"string","nullable":true},"<FileContent>k__BackingField":{"type":"string","nullable":true},"<ContentType>k__BackingField":{"type":"string","nullable":true},"<FileSize>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<ID>k__BackingField":{"type":"integer","format":"int32","nullable":true},"<HasContent>k__BackingField":{"type":"boolean"}},"description":"The nested Atreemo.Models.CtcCpyNotes.Attachment class is Serializable. The ordinary Web API formatter therefore exposes compiler backing-field names, not the property names used by a default Json.NET resolver. Runtime-unverified."},"SupInfo":{"type":"object","nullable":true,"properties":{"FieldContent":{"type":"string","nullable":true,"description":"Field value"},"FieldName":{"type":"string","nullable":true,"description":"Field name"}}}}},"paths":{"/api/Company/PutCompany":{"put":{"operationId":"CompanyPutCompany","summary":"PutCompany","tags":["Company"],"description":"Update an existing Household/Company","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}}}}
```


---

# 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/company.md?ask=<question>&goal=<user_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.