ACacculynx
company

Get Insurance Companies

Changed on

Use this endpoint to get a list of insurance companies for the current location. The response is paginated based on the pageSize and StartIndex query parameters and sorted by based on tag name in the order given by the sortOrder query parameter. All the query parameters are optional. pageSize defaults to 50 and StartIndex defaults to 0.

get/company-settings/job-file-settings/insurance-companies

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/company-settings/job-file-settings/insurance-companies
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger

How many items to be returned at a time.

recordStartIndexinteger

The zero-based index of the first record to return.

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "89082e73-39fa-4082-b097-9cb1351da726",
      "name": "Jim's Insurance",
      "isActive": true
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status