> For the complete documentation index, see [llms.txt](https://docs.navigaglobal.com/navigaid/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.navigaglobal.com/navigaid/services/admin-api/routes/internal-applications.md).

# Internal applications

## /internalApplications.get

<mark style="color:blue;">`GET`</mark> `https://admin-api.imid.infomaker.io/v1/internalApplications.get`

Get internal application

#### Query Parameters

| Name                  | Type   | Description             |
| --------------------- | ------ | ----------------------- |
| internalApplicationId | string | Internal application ID |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "id": "Internal application ID",
  "serviceId": "Service id",
  "name": "my-internal-application",
  "description": "Description of speicific part xxx"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /internalApplications.list

<mark style="color:blue;">`GET`</mark> `https://admin-api.imid.infomaker.io/v1/internalApplications.list`

List internal applications

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
|      | string |             |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
[
  {
    "id": "Internal application ID",
    "serviceId": "Service id",
    "name": "my-internal-application",
    "description": "Description of speicific part xxx"
  }
]
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /internalApplications.create

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/internalApplications.create`

Create internal application

#### Request Body

| Name        | Type   | Description                       |
| ----------- | ------ | --------------------------------- |
| serviceId   | string | Service id                        |
| name        | string | Internal application name         |
| description | string | Description of speicific part xxx |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "id": "Internal application ID",
  "serviceId": "Service id",
  "name": "my-internal-application",
  "description": "Description of speicific part xxx"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /internalApplications.createCredential

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/internalApplications.createCredential`

Create internal application credentials

#### Request Body

| Name                  | Type   | Description             |
| --------------------- | ------ | ----------------------- |
| internalApplicationId | string | Internal application ID |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "id": "Internal application credential ID",
  "clientSecret": "xxxxxx",
  "sanitizedClientSecret": "x*****x"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /internalApplications.delete

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/internalApplications.delete`

Delete internal application

#### Request Body

| Name                  | Type   | Description             |
| --------------------- | ------ | ----------------------- |
| internalApplicationId | string | Internal application ID |

{% tabs %}
{% tab title="204 No Content" %}

```javascript
""
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /internalApplications.deleteCredential

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/internalApplications.deleteCredential`

Delete internal application credential

#### Request Body

| Name                       | Type   | Description                        |
| -------------------------- | ------ | ---------------------------------- |
| internalApplicationId      | string | Internal application ID            |
| internalClientCredentialId | string | Internal application credential ID |

{% tabs %}
{% tab title="204 No Content" %}

```javascript
""
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}

## /internalApplications.modify

<mark style="color:green;">`POST`</mark> `https://admin-api.imid.infomaker.io/v1/internalApplications.modify`

Modify internal application

#### Request Body

| Name                  | Type   | Description                       |
| --------------------- | ------ | --------------------------------- |
| internalApplicationId | string | Internal application ID           |
| name                  | string | Internal application name         |
| description           | string | Description of speicific part xxx |

{% tabs %}
{% tab title="200 Successful" %}

```javascript
{
  "id": "Internal application ID",
  "serviceId": "Service id",
  "name": "my-internal-application",
  "description": "Description of speicific part xxx"
}
```

{% endtab %}

{% tab title="400 Bad Request" %}

```javascript
"errors.api.BadRequestError"
```

{% endtab %}

{% tab title="500 Internal Server Error" %}

```javascript
"errors.api.InternalServerError"
```

{% endtab %}
{% endtabs %}