REST API & Companion Plugin

Publish an artist’s gig listings and repertoire automatically to their own WordPress website — updated whenever you make changes in your agency install.

How it works

Your agency install acts as the central hub. Each artist’s own WordPress website installs the free PB Gig Diary Companion plugin and connects to your agency install via REST API. When you add or update a gig in your agency install, it appears automatically on the artist’s website — no double entry, no manual updates.

Setting up the REST API

1. Enable the REST API in your agency install

   Go to Gig Diary → Settings → General and enable the REST API option. An API key will be generated — copy this for use in the next step.

2. Note your agency site URL and artist slug

   You’ll need your agency site URL (e.g. https://myagency.co.uk) and the artist’s slug from Gig Diary → Artists.

Installing the companion plugin

1. Download the free PB Gig Diary Companion plugin from purebaltic.co.uk
2. Install it on the artist’s WordPress website via Plugins → Add New → Upload Plugin
3. Activate the plugin
4. Go to Gig Diary Companion → Settings and enter:

   • Your agency site URL
   • The artist’s slug
   • The API key from your agency install
5. Click Save and Test Connection to verify the link is working

Displaying gigs on the artist’s website

Once connected, use the same shortcode on the artist’s website as you would on your agency site:

[pb_gig_diary]

The companion plugin fetches the gig data from your agency install and displays it using the same styling and shortcode options. All the same parameters work — upcoming_only, past_only, count, year etc.

Displaying the repertoire on the artist’s website

The artist’s song catalogue can also be published on their own site:

[pb_artist_repertoire]

This pulls the active songs for that artist from your agency install.

How updates propagate

The companion plugin caches gig data locally and refreshes it periodically. When you make a change in your agency install:

• The artist’s website will reflect the change within a few minutes
• The cache can be manually cleared from Gig Diary Companion → Settings → Clear cache if you need an immediate update

REST API endpoints

For developers who want to build their own integration, the following endpoints are available on your agency install:

All requests require the X-PB-API-Key header with your API key.