--- updatedAt: 2026-06-24T19:22:21.000Z agentTools: projectIndex: https://portal.api.modmed.com/llms.txt --- # Retrieve List of all locations for that firm Use [Authentication Endpoint](https://portal.api.modmed.com/reference/post_ws-oauth2-grant#/) page to get token # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "EMA Proprietary API", "contact": { "email": "ankit.srivastava@modmed.com" }, "version": "3.4.3_FINAL", "description": "The EMA Proprietary FHIR API provides programmatic access to ModMed EMA clinical and practice-management data using FHIR R4-style resources under `/fhir/v2`.\n\nThis documentation targets the **public sandbox** (`stage.ema-api.com`).\n\n**Authentication.** Two mechanisms are supported during the current migration: the **legacy OAuth2 `password` grant** (being sunset) and the **new OAuth2 `client_credentials`** flow (recommended for new integrations) — see the **Authentication** guide. Every API call also requires the `x-api-key` header." }, "servers": [ { "url": "https://stage.ema-api.com/ema-dev/firm/apiportal/ema" } ], "tags": [ { "name": "Locations/Facilities", "description": "Locations/Facilities details" } ], "paths": { "/fhir/v2/Location": { "get": { "tags": [ "Locations/Facilities" ], "summary": "Retrieve List of all locations for that firm", "parameters": [ { "name": "_count", "in": "query", "description": "Number of records to use as the page size for paginated search. The maximum page size for this Resource is 100", "required": false, "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "This is an Optional Date in the format _lastUpdated=gtDATE, _lastUpdated=eqDATE and _lastUpdated=leDATE in the format yyyy-mm-dd", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "address-city", "in": "query", "description": "A city specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "address-country", "in": "query", "description": "A country specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "Is the Organization record active", "required": false, "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "A state specified in an address", "required": false, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "A portion of the location's name or alias", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page to be used for paginated search", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Searches for locations with a specific kind of status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/fhir+json": { "schema": { "$ref": "#/components/schemas/FHIR-JSON-RESOURCE" }, "example": { "resourceType": "Bundle", "id": "cb70ba05-d700-4276-bde4-19592fa89672", "meta": { "lastUpdated": "2026-06-25T14:56:06.003+00:00" }, "type": "searchset", "total": 2, "link": [ { "relation": "self", "url": "https://stage.ema-api.com/ema-dev/firm/apiportal/ema/fhir/v2/Location?_count=2" }, { "relation": "next", "url": "https://stage.ema-api.com/ema-dev/firm/apiportal/ema/fhir/v2/Location?_count=2&page=2" } ], "entry": [ { "fullUrl": "https://stage.ema-api.com/ema-dev/firm/apiportal/ema/fhir/v2/Location/826", "resource": { "resourceType": "Location", "id": "826", "meta": { "lastUpdated": "2025-02-20T16:27:11.000+00:00" }, "identifier": [ { "system": "BusinessUnitId", "value": "722" }, { "system": "PMSID", "value": "112416FAC000000001" } ], "status": "active", "name": "Main Street Clinic", "address": { "id": "720212", "line": [ "123 Main Street" ], "city": "Boca Raton", "state": "FL", "postalCode": "33437-1111", "country": "United States of America" } } }, { "fullUrl": "https://stage.ema-api.com/ema-dev/firm/apiportal/ema/fhir/v2/Location/827", "resource": { "resourceType": "Location", "id": "827", "meta": { "lastUpdated": "2025-02-20T16:39:18.000+00:00" }, "identifier": [ { "system": "BusinessUnitId", "value": "722" }, { "system": "PMSID", "value": "112416FAC000000002" } ], "status": "active", "name": "Yamato Road Clinic", "address": { "id": "720858", "line": [ "123 Yamato Road" ], "city": "Boca Raton", "state": "FL", "postalCode": "33437-1111", "country": "United States of America" } } } ] } }, "application/fhir+xml": { "schema": { "$ref": "#/components/schemas/FHIR-XML-RESOURCE" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "422": { "$ref": "#/components/responses/UnprocessableEntity" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/ServerError" } } } } }, "security": [ { "BearerAuth": [], "ApiKeyAuth": [] } ], "components": { "schemas": { "FHIR-JSON-RESOURCE": { "type": "object", "description": "A FHIR resource" }, "FHIR-XML-RESOURCE": { "type": "object", "description": "A FHIR resource" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth2 access token (JWT). Obtain it via the legacy `password` grant or the new `client_credentials` flow (see the **Authentication** guide), then send as `Authorization: Bearer `.", "x-default": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJhN2NiZmYwZWUxYjk0ODkwOWMxZmQzYzk3ODhlZjc1NCIsImlzcyI6Im1vZG1lZCIsInN1YiI6ImZoaXJfUWZMbG8iLCJ1cmxQcmVmaXgiOiJhcGlwb3J0YWwiLCJ0b2tlblR5cGUiOiJhY2Nlc3MiLCJ2ZW5kb3IiOiJmaGlyX1FmTGxvQGFwaXBvcnRhbCIsInBvbCI6ImNoYW5nZW1lIn0.f0VcA3R56IuAvdbPhInqUbhmEwk-tiOIeELVpTZCUZ8" }, "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "Shared **sandbox** API key (public sandbox only). Send as the `x-api-key` header.\n\n`Zt9tXPIgz17uxEU6gkZPWa3ZAFhZOqm04oEDHC1f`", "x-default": "Zt9tXPIgz17uxEU6gkZPWa3ZAFhZOqm04oEDHC1f" } }, "responses": { "BadRequest": { "description": "BAD REQUEST - The request was bad, often due to a missing required parameter" }, "Unauthorized": { "description": "NOT AUTHORIZED - Authentication error; this token is not allowed access to the API" }, "Forbidden": { "description": "FORBIDDEN" }, "NotFound": { "description": "NOT FOUND" }, "UnprocessableEntity": { "description": "UNPROCESSABLE ENTITY - Request could not be processed; typically a validation error" }, "TooManyRequests": { "description": "TOO MANY REQUESTS - Request was rate limited (1000 calls/min default); please retry" }, "ServerError": { "description": "SERVER ERROR - Internal Server Error" } } } } ```