Get Notification Providers

Get Notification Providers
Get all notification providers for an organization

Return a list of notification providers for the organization. The id of the organization is fetched from CSP token

Request
URI
GET
https://api.app-catalog.vmware.com/v1/notification-providers
COPY
Query Parameters
boolean
enabled
Optional

Filter by enabled status

boolean
removed
Optional

Filter by removed

string
order_field
Optional
Constraints: default: CREATED_AT

Name of the field to order the notification providers: CREATED_AT, UPDATED_AT, NAME

order_field example
CREATED_AT
string
order_direction
Optional
Constraints: default: DESC

Order to sort by the selected field: ASC or DESC (default)

integer
page
Optional
Constraints: minimum: 1 default: 1

An integer that identifies the page number for a paged response

integer
page_size
Optional
Constraints: minimum: 1 maximum: 100 default: 20

An integer that identifies the maximum page size for a paged response

Authentication
This operation uses the following authentication methods.
Responses
200

List of notification providers

Returns NotificationProviderPage of type(s) application/json
This response body class contains all of the following: Page , InlineNotificationProviderPage1 
{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "id": "e24ae877-6bfa-42da-a735-4ea55fba6c45",
            "name": "My Provider",
            "type": "string",
            "enabled": true,
            "notification_types": [
                "CRITICAL_CVE_PATCH_AVAILABLE"
            ],
            "created_at": "2025-10-31T12:42:14.000Z",
            "created_by": "johndoe",
            "updated_at": "2025-10-31T12:42:14.000Z",
            "updated_by": "johndoe",
            "removed_at": "2025-10-31T12:42:14.000Z",
            "removed_by": "johndoe"
        }
    ]
}

400

An error related to the request

Returns ConstraintsViolationsError of type(s) application/problem+json
This response body class contains all of the following: Error 
{
    "type": "https://example.com/probs/validation-error",
    "title": "Validation error",
    "status": 400,
    "detail": "There was an error validating the request",
    "violations": [
        {
            "field": "amount",
            "message": "It should be greater than zero"
        }
    ]
}

403

The requesting user is not authorized to get the notification providers

Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: Error 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

500

An internal server error object

Returns Error500 of type(s) application/problem+json
This response body class contains all of the following: Error 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json
This response body class contains all of the following: Error 
{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/notification-providers
On This Page
Notifications Operations
GET
Get Notification Providers
POST
Create Notification Provider
GET
Get Notification Provider
DELETE
Delete Notification Provider
PATCH
Update Notification Provider
PUT
Update Notification Types
GET
Get Notification Types