GET api/formularies?activeOnly={activeOnly}

Gets a collection of Formulary resources for a Company.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
activeOnly

Value indicating whether to return only active formularies. If true, only formularies that haven't been delete will be returned. If false, all formularies will be returned.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of formularies objects

Collection of FormularyModel
NameDescriptionTypeAdditional information
Name

The name of formulary

 string

None.
EffectiveDate

Effective Start Date of the Formulary

 date

None.
NonListedRxBrandFormularyStatus

This is the default Formulary Status for Brand Prescription Drugs that do not appear on the FormularyFormulary status is defined by using a simple, low-to-high scale. Drugs with a lower formulary status are considered less preferable by the payer; those with a higher status are more preferable. This value is only used when sending formulary status values to Surescripts. If no interface with Surescripts exists, these values can be ignored. 0 = Non-Reimbursable (Patient pays the full cost) 1 = Non-Formulary 2 = On Formulary/Non-Preferred 3 - 99 = On Formulary/Preferred(higher number means more preferred) U = Unknown Status

 integer

None.
NonListedRxGenericFormularyStatus

This is the default Formulary Status for Generic Prescription Drugs that do not appear on the FormularyFormulary status is defined by using a simple, low-to-high scale. Drugs with a lower formulary status are considered less preferable by the payer; those with a higher status are more preferable. This value is only used when sending formulary status values to Surescripts. If no interface with Surescripts exists, these values can be ignored. 0 = Non-Reimbursable (Patient pays the full cost) 1 = Non-Formulary 2 = On Formulary/Non-Preferred 3 - 99 = On Formulary/Preferred(higher number means more preferred) U = Unknown Status

 integer

None.
NonListedBrandOTCFormularyStatus

This is the default Formulary Status for Brand OTC Drugs that do not appear on the FormularyFormulary status is defined by using a simple, low-to-high scale. Drugs with a lower formulary status are considered less preferable by the payer; those with a higher status are more preferable. This value is only used when sending formulary status values to Surescripts. If no interface with Surescripts exists, these values can be ignored. 0 = Non-Reimbursable (Patient pays the full cost) 1 = Non-Formulary 2 = On Formulary/Non-Preferred 3 - 99 = On Formulary/Preferred(higher number means more preferred) U = Unknown Status

 integer

None.
NonListedGenericOTCFormularyStatus

This is the default Formulary Status for Generic OTC Drugs that do not appear on the FormularyFormulary status is defined by using a simple, low-to-high scale. Drugs with a lower formulary status are considered less preferable by the payer; those with a higher status are more preferable. This value is only used when sending formulary status values to Surescripts. If no interface with Surescripts exists, these values can be ignored. 0 = Non-Reimbursable (Patient pays the full cost) 1 = Non-Formulary 2 = On Formulary/Non-Preferred 3 - 99 = On Formulary/Preferred(higher number means more preferred) U = Unknown Status

 integer

None.
NonListedSuppliesFormularyStatus

This is the default Formulary Status for Supplies that do not appear on the FormularyFormulary status is defined by using a simple, low-to-high scale. Drugs with a lower formulary status are considered less preferable by the payer; those with a higher status are more preferable. This value is only used when sending formulary status values to Surescripts. If no interface with Surescripts exists, these values can be ignored. 0 = Non-Reimbursable (Patient pays the full cost) 1 = Non-Formulary 2 = On Formulary/Non-Preferred 3 - 99 = On Formulary/Preferred(higher number means more preferred) U = Unknown Status

 integer

None.
PublishToSurescripts

The value that determines whether this Formulary is sent to Surescripts (if a Surescripts interface is set up for this account)

 boolean

None.
NonListedRxBrandFormularyTierNo

The SeqNo of the Non Listed Brand Rx drugs that should be used for this formulary. Any brand Rx drug that is not listed on the formulary will be processed as if it were on the tier set here.

 integer

None.
NonListedRxBrandFormularyTierUrl

The URL for the NonListedRxBrandFormularyTier resource

 string

None.
NonListedRxGenericFormularyTierNo

The SeqNo of the Non Listed Generic Rx drugs that should be used for this formulary. Any generic Rx drug that is not listed on the formulary will be processed as if it were on the tier set here.

 integer

None.
NonListedRxGenericFormularyTierUrl

The URL for the NonListedRxGenericFormularyTier resource

 string

None.
NonListedBrandOTCFormularyTierNo

The SeqNo of the Non Listed Brand OTC drugs that should be used for this formulary. Any brand OTC drug that is not listed on the formulary will be processed as if it were on the tier set here.

 integer

None.
NonListedBrandOTCFormularyTierUrl

The URL for the NonListedBrandOTCFormularyTier resource

 string

None.
NonListedGenericOTCFormularyTierNo

The SeqNo of the Non Listed Generic OTC drugs that should be used for this formulary. Any generic OTC drug that is not listed on the formulary will be processed as if it were on the tier set here.

 integer

None.
NonListedGenericOTCFormularyTierUrl

The URL for the NonListedGenericOTCFormularyTier resource

 string

None.
NonListedSuppliesFormularyTierNo

The SeqNo of the Non Listed Supplies Tier drugs that should be used for this formulary. Any supply that is not listed on the formulary will be processed as if it were on the tier set here.

 integer

None.
NonListedSuppliesFormularyTierUrl

The URL for the NonListedSuppliesFormularyTier resource

 string

None.
isDeleted

Sets or gets the value that determines whether this formulary is "deleted" or not

 boolean

None.
Url

Gets or sets the link representing a link back to the resource

 string

None.
ID

Gets or sets the identifier for the resource

 integer

None.

Response Formats

application/json, text/json, application/json-patch+json

Sample: 
[
  {
    "url": "sample string 9",
    "id": 10,
    "name": "sample string 1",
    "effectiveDate": "2025-05-30T20:52:17.6516185-05:00",
    "nonListedRxBrandFormularyStatus": 1,
    "nonListedRxGenericFormularyStatus": 1,
    "nonListedBrandOTCFormularyStatus": 1,
    "nonListedGenericOTCFormularyStatus": 1,
    "nonListedSuppliesFormularyStatus": 1,
    "publishToSurescripts": true,
    "nonListedRxBrandFormularyTierNo": 1,
    "nonListedRxBrandFormularyTierUrl": "sample string 3",
    "nonListedRxGenericFormularyTierNo": 1,
    "nonListedRxGenericFormularyTierUrl": "sample string 4",
    "nonListedBrandOTCFormularyTierNo": 1,
    "nonListedBrandOTCFormularyTierUrl": "sample string 5",
    "nonListedGenericOTCFormularyTierNo": 1,
    "nonListedGenericOTCFormularyTierUrl": "sample string 6",
    "nonListedSuppliesFormularyTierNo": 1,
    "nonListedSuppliesFormularyTierUrl": "sample string 7",
    "isDeleted": true
  },
  {
    "url": "sample string 9",
    "id": 10,
    "name": "sample string 1",
    "effectiveDate": "2025-05-30T20:52:17.6516185-05:00",
    "nonListedRxBrandFormularyStatus": 1,
    "nonListedRxGenericFormularyStatus": 1,
    "nonListedBrandOTCFormularyStatus": 1,
    "nonListedGenericOTCFormularyStatus": 1,
    "nonListedSuppliesFormularyStatus": 1,
    "publishToSurescripts": true,
    "nonListedRxBrandFormularyTierNo": 1,
    "nonListedRxBrandFormularyTierUrl": "sample string 3",
    "nonListedRxGenericFormularyTierNo": 1,
    "nonListedRxGenericFormularyTierUrl": "sample string 4",
    "nonListedBrandOTCFormularyTierNo": 1,
    "nonListedBrandOTCFormularyTierUrl": "sample string 5",
    "nonListedGenericOTCFormularyTierNo": 1,
    "nonListedGenericOTCFormularyTierUrl": "sample string 6",
    "nonListedSuppliesFormularyTierNo": 1,
    "nonListedSuppliesFormularyTierUrl": "sample string 7",
    "isDeleted": true
  }
]