Skip to content

API Documentation

Build on the Niviyo API

RESTful endpoints, predictable responses and API-key authentication — everything you need to integrate Niviyo products into your stack.

Base URL

https://api.niviyo.com/v1/ngo

Endpoints

GET /members

List all members and volunteers with plan, status, and referral filters.

POST /members

Register a new member and trigger automatic ID card and joining letter generation.

GET /donations

Retrieve donation and crowdfunding collections with online and offline payment breakdowns.

POST /events

Create an event, program, or campaign visible on the NGO's own domain.

PUT /committees/{id}

Update a committee or morcha/wing, including its assigned office bearers.

DELETE /members/{id}

Deactivate a member record and revoke the linked ID card.

Sample Request

curl -X GET "https://api.niviyo.com/v1/ngo/donations?from=2026-06-01&to=2026-06-30" \
  -H "X-Niviyo-Key: nvy_live_xxxxxxxxxxxx" \
  -H "Accept: application/json"

Base URL

https://api.niviyo.com/v1/news

Endpoints

GET /articles

List published text and video news filtered by category, language, or reporter.

POST /articles

Publish a news article with multi-language body, category, and breaking-news flag.

GET /reporters

Retrieve reporters along with ID card status and payment records.

POST /reporters/{id}/payments

Record a reporter payment collected via QR code or payment gateway.

PUT /ad-boxes/{id}

Update an ad box placement, creative, and target category on the portal.

DELETE /articles/{id}

Unpublish and remove an article while preserving copyright protection logs.

Sample Request

curl -X GET "https://api.niviyo.com/v1/news/articles?category=politics&lang=hi&limit=20" \
  -H "X-Niviyo-Key: nvy_live_xxxxxxxxxxxx" \
  -H "Accept: application/json"

Base URL

https://api.niviyo.com/v1/epaper

Endpoints

GET /editions

List editions date-wise from the archive with pagination and search support.

POST /editions

Upload a PDF edition for automatic conversion into the interactive flipbook viewer.

GET /editions/{id}/pages

Fetch flipbook pages of an edition with zoom-ready image renditions.

POST /clips

Create a shareable article clip from a selected region of a page.

PUT /subscriptions/{id}

Update a reader's subscription plan and paywall access level.

DELETE /editions/{id}

Remove an edition and its pages from the public archive.

Sample Request

curl -X GET "https://api.niviyo.com/v1/epaper/editions?date=2026-07-03" \
  -H "X-Niviyo-Key: nvy_live_xxxxxxxxxxxx" \
  -H "Accept: application/json"

Base URL

https://api.niviyo.com/v1/autopost

Endpoints

GET /feeds

List connected RSS feed sources with fetch status and last import time.

POST /feeds

Add an RSS feed source with keyword filters and target category mapping.

GET /imports

Retrieve imported items with duplicate-detection results and publishing outcomes.

POST /feeds/{id}/run

Trigger an immediate fetch and publish cycle outside the schedule.

PUT /templates/{id}

Update a content template, including spinning rules and featured image behavior.

DELETE /feeds/{id}

Remove a feed source and stop its scheduled auto-publishing.

Sample Request

curl -X GET "https://api.niviyo.com/v1/autopost/feeds?status=active" \
  -H "X-Niviyo-Key: nvy_live_xxxxxxxxxxxx" \
  -H "Accept: application/json"

Base URL

https://api.niviyo.com/v1/socialpost

Endpoints

GET /queue

List scheduled shares in the smart queue across all connected networks.

POST /posts

Queue a WordPress post for sharing to Facebook, X, LinkedIn, Instagram, or Telegram.

GET /analytics/clicks

Retrieve click tracking and engagement metrics per network and per post.

POST /evergreen

Add a post to the evergreen library for automatic periodic re-sharing.

PUT /templates/{id}

Update a network-specific post template with hashtag and mention automation rules.

DELETE /queue/{id}

Cancel a queued share before it is published to social networks.

Sample Request

curl -X GET "https://api.niviyo.com/v1/socialpost/analytics/clicks?network=facebook&period=7d" \
  -H "X-Niviyo-Key: nvy_live_xxxxxxxxxxxx" \
  -H "Accept: application/json"

Authentication

All requests are authenticated with your API key sent in the X-Niviyo-Key header. Keys are available from your product dashboard — keep them secret and rotate them regularly.

Need Help Integrating?

Our engineers are happy to walk you through authentication, webhooks and best practices.

Submit a Ticket Talk to Us