Skip to main content
GET
/
products
List all products
curl --request GET \
  --url http://localhost:3001/portal-api/products \
  --header 'Authorization: <api-key>'
[
  {
    "ID": 2,
    "CID": "2r7p8aUnkzby17hCJk8w2XvK3K6",
    "APIDetails": [
      {
        "APIID": "a0ce49d559ce49d64fe608ea3728082a",
        "Name": "Payment API",
        "Status": true
      }
    ],
    "AuthType": "<string>",
    "AuthTypes": [
      "key",
      "oauth2"
    ],
    "DCREnabled": true,
    "DisplayName": "<string>",
    "Feature": true,
    "IsDocumentationOnly": false,
    "Name": "<string>",
    "Path": "<string>",
    "Preview": "/system/products/2/preview/preview.png",
    "ReferenceID": "<string>",
    "Scopes": "payments,clients",
    "SpecDetails": [
      {}
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Defaults to per_page query parameter value

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
ID
integer

UID of this API Product

Example:

2

​
CID
string

Client ID for this API Product

Example:

"2r7p8aUnkzby17hCJk8w2XvK3K6"

​
APIDetails
object[]
​
AuthType
string
​
AuthTypes
string[]

An array of strings specifying the authentication methods supported by the APIs within this Product (e.g., key, oauth2). When subscribing to a plan, a developer can choose one of these methods to generate credentials

Example:
["key", "oauth2"]
​
DCREnabled
boolean
​
DisplayName
string
​
Feature
boolean
​
IsDocumentationOnly
boolean
default:false

Must be false for regular API products

​
Name
string
​
Path
string
​
Preview
string

An image for the product's card view in the developer portal catalogue. This image is shown on the main API listing page. If not provided, the portal will fall back to using the product's Logo

Example:

"/system/products/2/preview/preview.png"

​
ReferenceID
string
​
Scopes
string

OAuth2.0 scopes that will be assigned to OAuth2.0 clients that use this API Product. Should be comma-separated string

Example:

"payments,clients"

​
SpecDetails
object[] | null

Specification details for documentation-only products