> For the complete documentation index, see [llms.txt](https://docs.mews.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mews.com/connector-api/operations/businesssegments.md). # Business segments ## Get all business segments Returns all business segments. This operation supports [Portfolio Access Tokens](/connector-api/concepts/multi-property.md). ### Request `[PlatformAddress]/api/connector/v1/businessSegments/getAll` ```javascript { "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "Ids": [ "7760b5cb-a666-41bb-9758-76bf5d1df399", "54ec08b6-e6fc-48e9-b8ae-02943e0ac693" ], "ServiceIds": [ "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "8c1bd738-a505-4b29-aa71-9ecc2982b843" ], "UpdatedUtc": { "StartUtc": "2023-10-01T00:00:00Z", "EndUtc": "2023-10-31T00:00:00Z" }, "ActivityStates": [ "Active" ], "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "Limitation": { "Count": 10 } } ``` | Property | Type | Contract | Description | | ---------------- | ------------------------------------------------------------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `ClientToken` | string | required | Token identifying the client application. | | `AccessToken` | string | required | Access token of the client application. | | `Client` | string | required | Name and version of the client application. | | `EnterpriseIds` | array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. | | `Ids` | array of string | optional, max 1000 items | Unique identifiers of the requested `Business segment`. | | `ServiceIds` | array of string | optional, max 1000 items | Unique identifiers of the `Services` from which the business segments are requested. | | `UpdatedUtc` | [Time interval](/connector-api/operations/_objects.md#time-interval) | optional, max length 3 months | Interval of `Business segment` last update date and time. | | `ActivityStates` | array of [Activity state](/connector-api/operations/_objects.md#activity-state) | optional | Whether to return only active, only deleted or both records. | | `Limitation` | [Limitation](/connector-api/guidelines/pagination.md#limitation) | required | Limitation on the quantity of data returned and optional Cursor for the starting point of data. | ### Response ```javascript { "BusinessSegments": [ { "Id": "7760b5cb-a666-41bb-9758-76bf5d1df399", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "IsActive": true, "Name": "Business", "CreatedUtc": "2023-10-01T00:00:00Z", "UpdatedUtc": "2023-10-01T00:00:00Z" }, { "Id": "54ec08b6-e6fc-48e9-b8ae-02943e0ac693", "ServiceId": "8c1bd738-a505-4b29-aa71-9ecc2982b843", "IsActive": true, "Name": "Leisure", "CreatedUtc": "2023-10-01T00:00:00Z", "UpdatedUtc": "2023-10-01T00:00:00Z" } ], "Cursor": "54ec08b6-e6fc-48e9-b8ae-02943e0ac693" } ``` | Property | Type | Contract | Description | | ------------------ | ---------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `BusinessSegments` | array of [Business segment](#business-segment) | required | Business segments. | | `Cursor` | string | optional | Unique identifier of the last and hence oldest business segment item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older business segment. | #### Business segment | Property | Type | Contract | Description | | ------------ | ------- | -------- | ------------------------------------------------------------------------------------- | | `Id` | string | required | Unique identifier of the business segment. | | `ServiceId` | string | required | Unique identifier of the `Service`. | | `IsActive` | boolean | required | Whether the business segment is still active. | | `Name` | string | required | Name of the business segment. | | `CreatedUtc` | string | required | Creation date and time of the business segment in UTC timezone in ISO 8601 format. | | `UpdatedUtc` | string | required | Last update date and time of the business segment in UTC timezone in ISO 8601 format. | --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.mews.com/connector-api/operations/businesssegments.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.