Docs / API reference

Provider catalog

Catalog of supported providers and the credentials each one needs.

Base URL https://your-server.example (your OneSend server). Authentication and errors are described in the overview.

Provider catalog

GET /v1/providers

Every provider OneSend can route through, with the credential fields to connect it and its known free tier.

Authentication: Authorization: Bearer with an API key or a session token.

Responses

200 Success

{
  "data": [{
    "id": string,
    "name": string,
    "website": string,
    "docsUrl": string,
    "description": string,
    "color": string,
    "category": string,
    "credentials": [{ … }],
    "freeTier": {
      "daily": number,
      "monthly": number,
      "note": string
    },
    "capabilities": map of boolean,
    "broadcastFriendly": boolean,
    "keyScopeHelp": string
  }]
}
Errors: 400, 401, 403, 404, 429, 500
  • 400 Invalid request: validation failed, a parameter is not allowed, the body is not valid JSON (invalid_json) or the pagination cursor is not valid (invalid_cursor). Type invalid_request.
  • 401 Missing credentials (unauthorized), an unknown or revoked API key (invalid_api_key) or an expired session (invalid_session). Type unauthorized.
  • 403 The API key's permission does not allow this operation (insufficient_scope; configuration needs an admin key), a test key was used outside its sandbox (test_key_not_allowed), a Conversion tracking key was used (publishable_key), or a cookie request is missing X-OneSend-Client: dashboard (csrf_header_required). Type forbidden.
  • 404 The resource does not exist in this workspace (not_found)
  • 429 Too many requests; retry after the time in the Retry-After header (rate_limited)
  • 500 Unexpected server error (internal)