RECENT UPDATES:
14-Nov-2026 | v7.13.1 | All new article

Change Log

  • 14-Nov-2026 | v7.13.1 | All new article

Contributors:

{
  "id": 2418,
  "name": "Adam Wilson",
  "url": "/adam-wilson"
}
Adam Wilson - Logo Pogo

External API Credentials API

Create, Retrieve, Update and Delete External API Credentials via the public API endpoint using "where" filtering. The list endpoint returns a short model, while a single credential can be retrieved by ID to access its full authentication details.

GET External API Credentials List

Retrieves a list of External API Credentials as a JSON response based on your provided query parameters.

Only the short model is returned for each credential. To retrieve a credential's secrets, use the External API Credential Item endpoint.

/api/v2/admin/external-api-credentials

Parameters

Parameter
Values
Required
Where
{<where query>}
Order_By
<propertyAlias>
Semantic_Query
<search query>
Min_Score
<double>
Offset
<integer>
Limit
<integer>

Data / Response:

N/A
{
  "Items": [
    {
      "Id": 0,
      "Name": "string",
      "Alias": "string",
      "AuthType": "OAuth2",
      "AuthTypeDisplayValue": "string",
      "CreatedDateTime": "2026-11-17T06:39:54.099Z"
    }
  ],
  "TotalItemsCount": 0
}

POST External API Credential Create

Creates a new External API Credential based on the provided data.

The Name, Alias and AuthType fields are required, and the Alias must not already be in use. The selected AuthType has its own required fields, and any fields belonging to other authentication types are ignored.

The available AuthType values and the fields each one uses are:

  • None - no authentication fields are used
  • Basic - UserName and Password
  • API Key - ApiKeyName, ApiKeyValue and ApiKeyType
  • OAuth2 - ClientId, ClientSecret, TokenUrl and Scopes
/api/v2/admin/external-api-credentials

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "AuthType": "OAuth2",
  "UserName": "string",
  "Password": "string",
  "ApiKeyName": "string",
  "ApiKeyValue": "string",
  "ApiKeyType": "Header",
  "ClientId": "string",
  "ClientSecret": "string",
  "TokenUrl": "string",
  "Scopes": [
    "string"
  ]
}
{
  "Id": 0,
  "AuthTypeDisplayValue": "string",
  "CreatedDateTime": "2026-11-17T06:39:54.101Z",
  "Name": "string",
  "Alias": "string",
  "AuthType": "OAuth2",
  "UserName": "string",
  "Password": "string",
  "ApiKeyName": "string",
  "ApiKeyValue": "string",
  "ApiKeyType": "Header",
  "ClientId": "string",
  "ClientSecret": "string",
  "TokenUrl": "string",
  "Scopes": [
    "string"
  ]
}

GET External API Credential Item

Retrieves a single External API Credential based on the ID passed in the endpoint URL.

The full model is returned, with only the fields relevant to the credential's AuthType holding a value.

/api/v2/admin/external-api-credentials/{id}

Data / Response:

N/A
{
  "Id": 0,
  "AuthTypeDisplayValue": "string",
  "CreatedDateTime": "2026-11-17T06:39:54.102Z",
  "Name": "string",
  "Alias": "string",
  "AuthType": "OAuth2",
  "UserName": "string",
  "Password": "string",
  "ApiKeyName": "string",
  "ApiKeyValue": "string",
  "ApiKeyType": "Header",
  "ClientId": "string",
  "ClientSecret": "string",
  "TokenUrl": "string",
  "Scopes": [
    "string"
  ]
}

PUT External API Credential Update

Updates a single External API Credential based on the ID passed in the endpoint URL and data provided.

Changing the AuthType clears the fields of the previous authentication type, so the credential never retains secrets it no longer uses.

/api/v2/admin/external-api-credentials/{id}

Data / Response:

{
  "Name": "string",
  "Alias": "string",
  "AuthType": "OAuth2",
  "UserName": "string",
  "Password": "string",
  "ApiKeyName": "string",
  "ApiKeyValue": "string",
  "ApiKeyType": "Header",
  "ClientId": "string",
  "ClientSecret": "string",
  "TokenUrl": "string",
  "Scopes": [
    "string"
  ]
}
{
  "Id": 0,
  "AuthTypeDisplayValue": "string",
  "CreatedDateTime": "2026-11-17T06:39:54.104Z",
  "Name": "string",
  "Alias": "string",
  "AuthType": "OAuth2",
  "UserName": "string",
  "Password": "string",
  "ApiKeyName": "string",
  "ApiKeyValue": "string",
  "ApiKeyType": "Header",
  "ClientId": "string",
  "ClientSecret": "string",
  "TokenUrl": "string",
  "Scopes": [
    "string"
  ]
}

DELETE External API Credential Delete

Deletes a single External API Credential based on the ID passed in the endpoint URL.

/api/v2/admin/external-api-credentials/{id}

Data / Response:

N/A
Status 204