API Reference
Publisher

Publisher

Manages publishers which have the authority to edit sites. A publisher can only be edited by that publisher or an admin account

These are authenticated endpoints. Requests to these endpoints must include a JWT Bearer token in the header of the request. Please see the documentation on authorization for how to go about obtaining a valid JWT token.

Getting the information of publisher

GET/v1/publisher/:id
PublisherAdmin

Takes a single path parameter id and returns information about the publisher.

Creating a new publisher

POST/v1/publisher
Admin

Takes a JSON payload containing the name of the publisher.

type InputPayload = {
  "name": string
}

Deleting a publisher

DELETE/v1/publisher/:id
Admin

Takes a single path parameter id and deletes the publisher.

Listing all publishers

GET/v1/publisher

Note that the result payload changes depending on whether the request was made by an admin or not (i.e. a publisher or regular, un-authenticated request). Admin requests return a list of all sites. All other requests only return a list of sites that have public set to true.

type ResultPayload = string[] // ID of sites