GET api/PharmacyLocations?page={page}&pagesize={pagesize}&pharmacyHeadquarterNo={pharmacyHeadquarterNo}&name={name}&city={city}&npi={npi}&ncpdp={ncpdp}&state={state}&activeOnly={activeOnly}&lastModifiedAfter={lastModifiedAfter}
Gets all pharmacy locations for this company matching the optional filters provided
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| page |
1-based index identifying the page # of results to return (optional, 1 by default) |
integer |
Default value is 1 |
| pagesize |
The number of records to return per page (optional, 25 by default, max 100) |
integer |
Default value is 25 |
| pharmacyHeadquarterNo |
The optional pharmacy headquarter id by which results will be filtered |
integer |
None. |
| name |
The optional name to use when filtering results |
string |
None. |
| city |
The optional city to use when filtering results |
string |
None. |
| npi |
The optional npi to use when filtering results |
string |
None. |
| ncpdp |
The optional ncpdp to use when filtering results |
string |
None. |
| state |
The optional state to use when filtering results |
string |
None. |
| activeOnly |
Value that determines whether only active results should be returned |
boolean |
None. |
| lastModifiedAfter |
This parameter is obsolete and is no longer functional. It will be removed completely in a future release |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
A Paged Result Model containing Pharmacy Location Models
PagedResultModelOfPharmacyLocationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PageNumber | integer |
None. |
|
| PageCount | integer |
None. |
|
| PageSize | integer |
None. |
|
| Items | Collection of PharmacyLocationModel |
None. |
|
| TotalRecordCount | integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{
"pageNumber": 1,
"pageCount": 2,
"pageSize": 3,
"items": [
{
"url": "sample string 43",
"id": 44,
"taxRate": 2.0,
"taxExempt": true,
"primaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"secondaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"tertiaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"is24HourOperation": true,
"providerHours": "sample string 5",
"dispenserClassCode": "sample string 6",
"contactFirstName": "sample string 7",
"contactMiddleName": "sample string 8",
"contactLastName": "sample string 9",
"contactTitle": "sample string 10",
"contactEmailAddress": "sample string 11",
"contactPhone": "sample string 12",
"contactPhoneExt": "sample string 13",
"storeNumber": "sample string 14",
"primaryRelationshipCode": "sample string 15",
"chainCode": "sample string 16",
"franchiseCode": "sample string 17",
"pharmacyHeadquarterNo": 19,
"pharmacyHeadquarterUrl": "sample string 20",
"pharmacyHeadquarterLock": true,
"overridePaymentCenters": true,
"paymentPayablesCenterNo": 1,
"paymentPayablesCenterUrl": "sample string 23",
"remitPayablesCenterNo": 1,
"remitPayablesCenterUrl": "sample string 24",
"openDate": "2026-04-04T04:33:57.9745785-05:00",
"closureDate": "2026-04-04T04:33:57.9745785-05:00",
"reinstatementDate": "2026-04-04T04:33:57.9745785-05:00",
"paymentMethod": "sample string 28",
"financialInstitutionID": "sample string 29",
"financialInstitutionAccountNo": "sample string 30",
"sync": true,
"locationName": "sample string 32",
"locationPrintName": "sample string 33",
"primaryAddress": {
"addressType": 0,
"displaySequence": 1,
"address1": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6",
"latitude": 1.0,
"longitude": 1.0
},
"mailingAddress": {
"addressType": 0,
"displaySequence": 1,
"address1": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6",
"latitude": 1.0,
"longitude": 1.0
},
"primaryPhone": {
"phoneType": 0,
"displaySequence": 1,
"phone1": "sample string 2",
"ext": "sample string 3",
"dialString": "sample string 4"
},
"dea": "sample string 34",
"ncpdp": "sample string 35",
"npi": "sample string 36",
"emailAddress": "sample string 37",
"webAddress": "sample string 38",
"federalTaxID": "sample string 39",
"comment": "sample string 40",
"active": 1,
"timeZone": "sample string 41",
"medicareID": "sample string 42"
},
{
"url": "sample string 43",
"id": 44,
"taxRate": 2.0,
"taxExempt": true,
"primaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"secondaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"tertiaryPharmacyType": {
"description": "sample string 1",
"pharmacyTypeCode": "sample string 2"
},
"is24HourOperation": true,
"providerHours": "sample string 5",
"dispenserClassCode": "sample string 6",
"contactFirstName": "sample string 7",
"contactMiddleName": "sample string 8",
"contactLastName": "sample string 9",
"contactTitle": "sample string 10",
"contactEmailAddress": "sample string 11",
"contactPhone": "sample string 12",
"contactPhoneExt": "sample string 13",
"storeNumber": "sample string 14",
"primaryRelationshipCode": "sample string 15",
"chainCode": "sample string 16",
"franchiseCode": "sample string 17",
"pharmacyHeadquarterNo": 19,
"pharmacyHeadquarterUrl": "sample string 20",
"pharmacyHeadquarterLock": true,
"overridePaymentCenters": true,
"paymentPayablesCenterNo": 1,
"paymentPayablesCenterUrl": "sample string 23",
"remitPayablesCenterNo": 1,
"remitPayablesCenterUrl": "sample string 24",
"openDate": "2026-04-04T04:33:57.9745785-05:00",
"closureDate": "2026-04-04T04:33:57.9745785-05:00",
"reinstatementDate": "2026-04-04T04:33:57.9745785-05:00",
"paymentMethod": "sample string 28",
"financialInstitutionID": "sample string 29",
"financialInstitutionAccountNo": "sample string 30",
"sync": true,
"locationName": "sample string 32",
"locationPrintName": "sample string 33",
"primaryAddress": {
"addressType": 0,
"displaySequence": 1,
"address1": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6",
"latitude": 1.0,
"longitude": 1.0
},
"mailingAddress": {
"addressType": 0,
"displaySequence": 1,
"address1": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6",
"latitude": 1.0,
"longitude": 1.0
},
"primaryPhone": {
"phoneType": 0,
"displaySequence": 1,
"phone1": "sample string 2",
"ext": "sample string 3",
"dialString": "sample string 4"
},
"dea": "sample string 34",
"ncpdp": "sample string 35",
"npi": "sample string 36",
"emailAddress": "sample string 37",
"webAddress": "sample string 38",
"federalTaxID": "sample string 39",
"comment": "sample string 40",
"active": 1,
"timeZone": "sample string 41",
"medicareID": "sample string 42"
}
],
"totalRecordCount": 4
}