API Developer Portal
Developer Portal Key Instructions
The apikeys endpoint allows developers to manage CustomerKeys for their accounts through API calls.
Authentication with a DeveloperPortalKey is required to access this endpoint.
Log in to the Developer Portal to generate and manage your DeveloperPortalKey.
Authorization Header Format: ODFHIR {DeveloperKey}/{DeveloperPortalKey}
ApiKeys GET (multiple)
Returns all CustomerKeys associated with your account.
Example Requests:
GET /apikeys
Example Response:
[
{
"CustomerKey": "QJXZR4PNK5B8W2HD",
"KeyStatus": "DisabledByDeveloper",
"DateCreated": "2022-05-25",
"DateDisabled": "2025-08-29",
"DateTimeAssigned": "2022-06-22 03:37:33",
"DevRefId": "Sarah's Super Dental"
},
"CustomerKey": "AAM2DYNOLF0F7ZUD",
"KeyStatus": "Enabled",
"DateCreated": "2024-12-04",
"DateDisabled": "0001-01-01",
"DateTimeAssigned": "0001-01-01 00:00:00",
"DevRefId": ""
},
{
"CustomerKey": "93R8TEL22OI4UPYX",
"KeyStatus": "Enabled",
"DateCreated": "2024-12-04",
"DateDisabled": "0001-01-01",
"DateTimeAssigned": "0001-01-01 00:00:00",
"DevRefId": ""
},
{
"CustomerKey": "565ATSAH4SZDUTTK",
"KeyStatus": "Enabled",
"DateCreated": "2025-06-12",
"DateDisabled": "0001-01-01",
"DateTimeAssigned": "0001-01-01 00:00:00",
"DevRefId": ""
}
]
200 OK
400 BadRequest (with explanation)
401 Unauthorized (with explanation)
ApiKeys POST (create)
Creates and returns a new CustomerKey. This is the most common call when onboarding a new practice.
Example Requests:
POST /apikeys
Example Response:
{
"CustomerKey": "565ATSAH4SZDUTTK",
"KeyStatus": "Enabled",
"DateCreated": "2025-06-12",
"DateDisabled": "0001-01-01",
"DateTimeAssigned": "0001-01-01 00:00:00",
"DevRefId": ""
}
201 Created
400 BadRequest (with explanation)
401 Unauthorized (with explanation)
ApiKeys PUT (update)
Updates the status or metadata of an existing CustomerKey.
CustomerKey: Required. The customer key to update.
KeyStatus: Optional. Either "Enabled" or "DisabledByDeveloper".
DevRefId: Optional. A developer referenced identifier. Only displays in the Developer Portal.
Example Requests:
PUT /apikeys
{
"CustomerKey": "QJXZR4PNK5B8W2HD",
"KeyStatus": "DisabledByDeveloper",
"DevRefId": "Sarah's Super Dental"
}
Example Response:
{
"CustomerKey": "QJXZR4PNK5B8W2HD",
"KeyStatus": "DisabledByDeveloper",
"DateCreated": "2021-05-25",
"DateDisabled": "2025-08-29",
"DateTimeAssigned": "2021-06-22 03:37:33",
"DevRefId": "Sarah's Super Dental"
}
200 OK
400 BadRequest (with explanation)
401 Unauthorized (with explanation)
404 NotFound (with explanation)