Back
5 Aug 2024

API documentation

SubPage provides the following API endpoints, to receive notification on events like a new blog post, a new job post or a new lead been generated on your published SubPage.


Authentication

All the requests made to the endpoints should contain api_key parameter. You can obtain the API key from the "Integrations" sections of your SubPage


Profile endpoint

This endpoint provides basic information about the current SubPage account.


GET https://editor.subpage.app/call/api/zapier/validateuser


Request parameters

api_key - API key of the SubPage domain


Response

status - Either "success" or "error"

domain - The domain name belonging to the SubPage based on the API key


Sample response

{
status: "success",
domain: "example.com"
}


Triggers endpoint

This endpoint provides the available notifications for the provided event in the current SubPage account.


GET https://editor.subpage.app/call/api/zapier/listtrigger


Request parameters

api_key - API key of the SubPage domain

event - Type of the event like "new_article", "new_lead", etc.


Response

Response is an array of events whose properties varies by the event type. Following example is for a "new_lead"


Sample response

[{
	id: "OFUWIHCSL",
	email: "newlead@example.com",
	ebook: false,
	timestamp: 1722862412000,
	city: "New York",
	country: "us",
	countryName: "United States",
	os: "MacOS",
	browser: "Chrome",
	displayDate: "2024-08-05 12:53:32"
}]


Share:

Stay Updated with Our Latest Blog Posts

Subscribe to receive the latest insights, articles, and updates straight to your inbox.

...