List service types - Cedar.AI Documentation

curl --request POST \ --url https://api-lg.arms.cedarai.com/rms/service_types/list \ --header 'Content-Type: application/json' \ --header 'x-arms-api-key: <api-key>' \ --header 'x-arms-assume-user: <api-key>' \ --data '{}'

{ "items": [ { "serviceTypeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "carrierId": 123, "serviceTypeName": "<string>", "serviceTypeCode": "<string>", "contextType": "INCIDENTAL", "serviceTypeGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "serviceTypeGroupName": "<string>", "defaultTaxIds": [ "3c90c3cc-0d44-4b50-8888-8dd25736052a" ], "createdAt": "2023-11-07T05:31:56Z", "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedAt": "2023-11-07T05:31:56Z", "updatedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "deletedAt": "2023-11-07T05:31:56Z", "deletedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a" } ], "contract": { "effect": "overwrite", "resourceType": "ServiceType" } }

Authorizations

x-arms-api-key

string

header

required

Your ARMS API key

x-arms-assume-user

string

header

required

Email of a user assigned to the appropriate user group

Query Parameters

carrierId

integer

required

Carrier identifier; required for all endpoints

Body

application/json

carrierId

integer

Carrier identifier. Defaults to the carrierId query parameter; if you send it, use the same value.

serviceTypeIds

string<uuid>[]

Optional filter by service type IDs.

serviceTypeCode

string

Optional filter by exact service type code.

serviceTypeGroupId

string<uuid>

Optional filter by service type group.

getDeleted

boolean

default:false

Also return service types that were deleted in ARMS (they have deletedAt).

Response

items

object[]

Show child attributes

contract

object

Show child attributes