> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/service/list-service-insurance-companies.md).

# List service insurance companies

List the tenant's insurance companies — the insurers the tenant's service orders name, each linked to the customer record that stands for it. The list is the intake wizard's insurer picker: picking an entry puts its customerUid on the service order as insuranceCompanyCustomerUid. Pass deprecated to list only the deprecated entries or only the ones still offered; left out, every entry is listed. A deprecated entry stays in the list but is not offered in the picker. Reading them asks for any service permission — SERVICE\_ORDER or SERVICE\_STORE\_CONFIG at the tenant, at an organization or at any one store, or SERVICE\_CONFIG, which is held at the tenant only — because whoever configures the insurance companies reads them, and the service screens read them to work. A tenant-wide ADMIN grant counts as every permission. A caller holding none of them, a user with no role assignments included, is refused with a 403.

Required permissions: SERVICE\_ORDER, SERVICE\_STORE\_CONFIG, SERVICE\_CONFIG

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Service","description":"Service"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"InsuranceCompanyListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceCompanyResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"]}}}}},"schemas":{"InsuranceCompanyResponseSchema":{"title":"InsuranceCompanyResponseSchema","description":"An insurance company entry: one of the insurers the tenant's service orders name, linked to the customer record that stands for it. The tenant's entries are the intake wizard's insurer picker — picking one puts its customerUid on the service order as insuranceCompanyCustomerUid, so no service order references the entry itself and it is deletable at any time.\nThe entry goes with its customer record: deleting the record deletes the entry, and merging the record into another customer moves the entry to that customer. customerName is the linked customer's display name as it reads now.\nA deprecated entry stays in the list but is not offered in the picker.","type":"object","required":["insuranceCompanyUid","tenantUid","name","customerUid","customerName","deprecated","createdAt","createdBy","lastModifiedAt","lastModifiedBy"],"properties":{"insuranceCompanyUid":{"$ref":"#/components/schemas/UID"},"tenantUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string","description":"What the insurer is called, as it is shown in the picker. Unique within the tenant."},"customerUid":{"description":"The customer record that stands for the insurer. Linked by this entry alone.","type":"string","pattern":"^[A-Za-z0-9-_]+"},"customerName":{"type":"string","description":"The linked customer's display name as it reads now."},"deprecated":{"type":"boolean","description":"A deprecated entry stays in the list but is not offered in the picker."},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"},"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"}},"parameters":{"serviceInsuranceCompanyDeprecatedQuery":{"name":"deprecated","in":"query","required":false,"schema":{"type":"boolean"},"description":"Filter by the deprecated flag: true lists only the deprecated entries, false only the entries still offered in the picker. Left out, every entry is listed."},"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"}}},"paths":{"/tenants/{tenantUid}/serviceorders/insurancecompanies":{"get":{"summary":"List service insurance companies","tags":["Service"],"responses":{"200":{"$ref":"#/components/responses/InsuranceCompanyListResponse"}},"operationId":"get-serviceorders-insurancecompanies","description":"List the tenant's insurance companies — the insurers the tenant's service orders name, each linked to the customer record that stands for it. The list is the intake wizard's insurer picker: picking an entry puts its customerUid on the service order as insuranceCompanyCustomerUid.\nPass deprecated to list only the deprecated entries or only the ones still offered; left out, every entry is listed. A deprecated entry stays in the list but is not offered in the picker.\nReading them asks for any service permission — SERVICE_ORDER or SERVICE_STORE_CONFIG at the tenant, at an organization or at any one store, or SERVICE_CONFIG, which is held at the tenant only — because whoever configures the insurance companies reads them, and the service screens read them to work. A tenant-wide ADMIN grant counts as every permission. A caller holding none of them, a user with no role assignments included, is refused with a 403.\n\nRequired permissions: SERVICE_ORDER, SERVICE_STORE_CONFIG, SERVICE_CONFIG","parameters":[{"$ref":"#/components/parameters/serviceInsuranceCompanyDeprecatedQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}]}}}}
```


---

# 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.flowretail.com/docs/developers/api-documentation/service/list-service-insurance-companies.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.
