---
title: "Accessing the IMS Developer Portal"
slug: "accessing-the-ims-developer-portal"
updated: 2026-10-27T23:11:38Z
published: 2026-10-27T23:11:38Z
canonical: "ims-handbook.cenosco.com/accessing-the-ims-developer-portal"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://ims-handbook.cenosco.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Accessing the IMS Developer Portal

To access the IMS Developer Portal on any instance of IMS:

- Navigate to the Developer Portal address in your web browser:
  - [URL]/developer - (e.g.: [https://ims-sandbox.cenosco.software/developer](https://ims-sandbox.cenosco.software/developer))

The IMS Developer Portal will be displayed in your browser.

![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-WE4VUGO7.png?sv=2026-02-06&spr=https&st=2026-10-28T16%3A06%3A12Z&se=2026-10-28T17%3A06%3A12Z&sr=c&sp=r&sig=pxTZvs9vkyUIGvlMKt35DO2CzFsp2oFE5mkFPeZvstw%3D)

IMS Developer Portal

All of the available APIs will be listed, grouped by functionality. To view the specific APIs available in each section:

- Click on the desired row to expand the list of APIs under that category.

![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-YK05TGOY.png?sv=2026-02-06&spr=https&st=2026-10-28T16%3A06%3A12Z&se=2026-10-28T17%3A06%3A12Z&sr=c&sp=r&sig=pxTZvs9vkyUIGvlMKt35DO2CzFsp2oFE5mkFPeZvstw%3D)

Categories expanded to show available APIs

> [!NOTE]
> Note
> 
> The specific APIs available to you may vary, depending on the site-specific IMS Implementation.

## API Types

APIs in the Developer Portal are colour-coded and labeled by functionality:

| API Type | Functionality |
| --- | --- |
| ![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-U0DLWNFI.png?sv=2026-02-06&spr=https&st=2026-10-28T16%3A06%3A12Z&se=2026-10-28T17%3A06%3A12Z&sr=c&sp=r&sig=pxTZvs9vkyUIGvlMKt35DO2CzFsp2oFE5mkFPeZvstw%3D) | **GET** APIs are used to retrieve information from the database, without changing any of the underlying data. |
| ![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-IWZ2S63E.png?sv=2026-02-06&spr=https&st=2026-10-28T16%3A06%3A12Z&se=2026-10-28T17%3A06%3A12Z&sr=c&sp=r&sig=pxTZvs9vkyUIGvlMKt35DO2CzFsp2oFE5mkFPeZvstw%3D) | **POST** APIs are used to add new information to the database. |
| ![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-2D10Q1T6.png?sv=2026-02-06&spr=https&st=2026-10-28T16%3A06%3A12Z&se=2026-10-28T17%3A06%3A12Z&sr=c&sp=r&sig=pxTZvs9vkyUIGvlMKt35DO2CzFsp2oFE5mkFPeZvstw%3D) | **PATCH** APIs are used to update existing information in the database. |
| ![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-J37VS2NV.png?sv=2026-02-06&spr=https&st=2026-10-28T16%3A06%3A12Z&se=2026-10-28T17%3A06%3A12Z&sr=c&sp=r&sig=pxTZvs9vkyUIGvlMKt35DO2CzFsp2oFE5mkFPeZvstw%3D) | **DELETE** APIs are used to delete records or other information in the database. |

> [!NOTE]
> Note
> 
> Developers should be particularly careful about using POST, PATCH and DELETE APIs due to the fact that they can change existing records in the IMS Database.

## API Documentation

To access the instructions for using each of the APIs:

- Click on the line corresponding to the desired API.

When the line corresponding to the desired API has been clicked, the available API documentation will show. This includes:

- Description.
- Usage examples.
- Required parameters.
- Potential responses to requests, together with an example of the type of data that might be returned.

![](https://cdn.document360.io/e492a0e0-a4ba-4aca-8fc6-76b95f91fdf3/Images/Documentation/image-M45UL6F4.png?sv=2026-02-06&spr=https&st=2026-10-28T16%3A06%3A12Z&se=2026-10-28T17%3A06%3A12Z&sr=c&sp=r&sig=pxTZvs9vkyUIGvlMKt35DO2CzFsp2oFE5mkFPeZvstw%3D)

Expanded API showing Description, Examples, Parameters and Responses.

Read on to learn about [Cenosco’s Authentication Service](/v414/docs/cenauth-authentication).