Olvy API Documentation

These are the developer docs for Olvy API. For information on how to use Olvy on your site, check out this video.

Fetch Everything - Fetch your organization, release notes, categories, and projects in one API call

To fetch everything about your releases, make a GET request to https://app.olvy.co/api/v1/organisations/releases/public/everything

Params

cURL Example

Paste this into your terminal,

curl --location --request GET 'https://app.olvy.co/api/v1/organisations/releases/public/everything'

JavaScript Example

var requestOptions = { 
    method: 'GET', 
    redirect: 'follow' 
};
fetch("https://app.olvy.co/api/v1/organisations/releases/public/everything", requestOptions) 
    .then(response => response.text()) 
    .then(result => console.log(result)) 
    .catch(error => console.log('error', error));

Get Organization - Fetch your organization's public details

To fetch your organization, make a GET request to https://app.olvy.co/api/v1/organisations/releases/public/

cURL Example

Paste this into your terminal,

curl --location --request GET 'https://app.olvy.co/api/v1/organisations/releases/public'

JavaScript Example

var requestOptions = { 
    method: 'GET', 
    redirect: 'follow' }; 
fetch("https://app.olvy.co/api/v1/organisations/releases/public", requestOptions) 
    .then(response => response.text()) 
    .then(result => console.log(result)) 
    .catch(error => console.log('error', error));

Get Release Notes - Fetch your live release notes

To fetch your release notes, make a GET request to https://app.olvy.co/api/v1/organisations/releases/public/release_notes

Params

cURL Example

Paste this into your terminal,

curl --location --request GET 'https://app.olvy.co/api/v1/organisations/releases/public/release_notes'

JavaScript Example

var requestOptions = { 
method: 'GET', 
redirect: 'follow' }; fetch("https://app.olvy.co/api/v1/organisations/piedpiper/public/release_notes", requestOptions) 
.then(response => response.text()) 
.then(result => console.log(result)) 
.catch(error => console.log('error', error));

Get Projects - Fetch your active projects

To fetch your projects make a GET request to https://app.olvy.co/api/v1/organisations/releases/public/projects

Params

cURL Example

Paste this into your terminal,

curl --location --request GET 'https://app.olvy.co/api/v1/organisations/releases/public/projects'

JavaScript Example

var requestOptions = { 
    method: 'GET', 
    redirect: 'follow' }; fetch("https://app.olvy.co/api/v1/organisations/piedpiper/public/projects", requestOptions) 
        .then(response => response.text()) 
        .then(result => console.log(result)) 
        .catch(error => console.log('error', error));

Get Categories - Fetch your active categories

To fetch your categories, make a GET request to https://app.olvy.co/api/v1/organisations/releases/public/categories

Params

cURL Example

Paste this into your terminal,

curl --location --request GET 'https://app.olvy.co/api/v1/organisations/releases/public/categories'

JavaScript Example

var requestOptions = { 
method: 'GET', 
redirect: 'follow' }; fetch("https://app.olvy.co/api/v1/organisations/piedpiper/public/categories", requestOptions) 
.then(response => response.text()) 
.then(result => console.log(result)) 
.catch(error => console.log('error', error));