Get all providers

1min
GET
https://{domain}/core/api/v1/messaging-service/providers
Get all Providers created for the tenant
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Query Parameters
mode
string
active
boolean
provider-type
string
page
string<uuid>
limit
integer
Responses
200
Successful operation
SpConfigResponses
error
Error
data
SPConfigResponseBody[]
meta
NextPageMeta
request
Request
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v1/messaging-service/providers?limit=10' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{domain}/core/api/v1/messaging-service/providers?limit=10' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
404
503
// Successful operation 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": [
    {
      "name": "aws-ses-external",
      "credentials": "secure:6a88954c-90f7-432d-b302-a2a75ede32fa",
      "isActive": false,
      "providerType": "ses",
      "mode": "",
      "isTenantDefault": false,
      "isOS1Default": false
    }
  ],
  "meta": {
    "hasNextPage": false,
    "pageId": "992bf4f5-0b58-4e49-aee5-47a86b7947ee"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
// Successful operation 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "data": [
    {
      "name": "aws-ses-external",
      "credentials": "secure:6a88954c-90f7-432d-b302-a2a75ede32fa",
      "isActive": false,
      "providerType": "ses",
      "mode": "",
      "isTenantDefault": false,
      "isOS1Default": false
    }
  ],
  "meta": {
    "hasNextPage": false,
    "pageId": "992bf4f5-0b58-4e49-aee5-47a86b7947ee"
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  }
}
﻿
﻿
Updated 28 Jun 2024
Did this page help you?
Create Service Provider Configs
Get specific provider instance by name