Koalect Public API

Campaigns

getCampaign

Returns a specific campaigns

/api/public/campaigns/{campaign_id}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json,text/plain"\
 "http://v2.koalect.com/api/public/campaigns/{campaign_id}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        UUID campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            CampaignShow result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaign");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        UUID campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            CampaignShow result = apiInstance.getCampaign(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#getCampaign");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];
UUID *campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

[apiInstance getCampaignWith:campaignId
              completionHandler: ^(CampaignShow output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var KoalectPublicApi = require('koalect_public_api');

// Create an instance of the API class
var api = new KoalectPublicApi.CampaignsApi()
var campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCampaign(campaignId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCampaignExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new CampaignsApi();
            var campaignId = new UUID(); // UUID |  (default to null)

            try {
                CampaignShow result = apiInstance.getCampaign(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.getCampaign: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();
$campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $result = $api_instance->getCampaign($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->getCampaign: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();
my $campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval { 
    my $result = $api_instance->getCampaign(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->getCampaign: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()
campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try: 
    api_response = api_instance.get_campaign(campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->getCampaign: %s\n" % e)

extern crate CampaignsApi;

pub fn main() {
    let campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = CampaignsApi::Context::default();
    let result = client.getCampaign(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
campaign_id*	UUID (uuid) Required

Responses

Schema

Schema

listCampaigns

Returns all campaigns

/api/public/campaigns

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://v2.koalect.com/api/public/campaigns"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        CampaignsApi apiInstance = new CampaignsApi();
        
        try {
            array[Object] result = apiInstance.listCampaigns();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#listCampaigns");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.CampaignsApi;

public class CampaignsApiExample {
    public static void main(String[] args) {
        CampaignsApi apiInstance = new CampaignsApi();
        
        try {
            array[Object] result = apiInstance.listCampaigns();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#listCampaigns");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
CampaignsApi *apiInstance = [[CampaignsApi alloc] init];

[apiInstance listCampaignsWithCompletionHandler: 
              ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var KoalectPublicApi = require('koalect_public_api');

// Create an instance of the API class
var api = new KoalectPublicApi.CampaignsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCampaigns(callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCampaignsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new CampaignsApi();

            try {
                array[Object] result = apiInstance.listCampaigns();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CampaignsApi.listCampaigns: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CampaignsApi();

try {
    $result = $api_instance->listCampaigns();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->listCampaigns: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CampaignsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CampaignsApi->new();

eval { 
    my $result = $api_instance->listCampaigns();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CampaignsApi->listCampaigns: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.CampaignsApi()

try: 
    api_response = api_instance.list_campaigns()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CampaignsApi->listCampaigns: %s\n" % e)

extern crate CampaignsApi;

pub fn main() {

    let mut context = CampaignsApi::Context::default();
    let result = client.listCampaigns(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Schema

Projects

getProject

Returns a specific project

/api/public/projects/{project_id}

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json,text/plain"\
 "http://v2.koalect.com/api/public/projects/{project_id}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        UUID projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            ProjectShow result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProject");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        UUID projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            ProjectShow result = apiInstance.getProject(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#getProject");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
UUID *projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

[apiInstance getProjectWith:projectId
              completionHandler: ^(ProjectShow output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var KoalectPublicApi = require('koalect_public_api');

// Create an instance of the API class
var api = new KoalectPublicApi.ProjectsApi()
var projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProject(projectId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProjectExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = new UUID(); // UUID |  (default to null)

            try {
                ProjectShow result = apiInstance.getProject(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.getProject: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $result = $api_instance->getProject($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->getProject: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval { 
    my $result = $api_instance->getProject(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->getProject: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try: 
    api_response = api_instance.get_project(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->getProject: %s\n" % e)

extern crate ProjectsApi;

pub fn main() {
    let projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ProjectsApi::Context::default();
    let result = client.getProject(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
project_id*	UUID (uuid) Required

Responses

Schema

Schema

listProjectdonations

Returns all donations of a specific project

/api/public/projects/{project_id}/donations

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json,text/plain"\
 "http://v2.koalect.com/api/public/projects/{project_id}/donations"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        UUID projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            ProjectDonations result = apiInstance.listProjectdonations(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#listProjectdonations");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        UUID projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            ProjectDonations result = apiInstance.listProjectdonations(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#listProjectdonations");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
UUID *projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (default to null)

[apiInstance listProjectdonationsWith:projectId
              completionHandler: ^(ProjectDonations output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var KoalectPublicApi = require('koalect_public_api');

// Create an instance of the API class
var api = new KoalectPublicApi.ProjectsApi()
var projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {UUID} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjectdonations(projectId, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listProjectdonationsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var projectId = new UUID(); // UUID |  (default to null)

            try {
                ProjectDonations result = apiInstance.listProjectdonations(projectId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.listProjectdonations: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $result = $api_instance->listProjectdonations($projectId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->listProjectdonations: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval { 
    my $result = $api_instance->listProjectdonations(projectId => $projectId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->listProjectdonations: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (default to null)

try: 
    api_response = api_instance.list_projectdonations(projectId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->listProjectdonations: %s\n" % e)

extern crate ProjectsApi;

pub fn main() {
    let projectId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ProjectsApi::Context::default();
    let result = client.listProjectdonations(projectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
project_id*	UUID (uuid) Required

Responses

Schema

Schema

listProjects

Returns all projects

/api/public/projects

Usage and SDK Samples

curl -X GET\
 -H "Accept: application/json"\
 "http://v2.koalect.com/api/public/projects?campaign_id="

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ProjectsApi;

import java.io.File;
import java.util.*;

public class ProjectsApiExample {
    public static void main(String[] args) {
        
        // Create an instance of the API class
        ProjectsApi apiInstance = new ProjectsApi();
        UUID campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            array[Object] result = apiInstance.listProjects(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#listProjects");
            e.printStackTrace();
        }
    }
}

import org.openapitools.client.api.ProjectsApi;

public class ProjectsApiExample {
    public static void main(String[] args) {
        ProjectsApi apiInstance = new ProjectsApi();
        UUID campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 
        
        try {
            array[Object] result = apiInstance.listProjects(campaignId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProjectsApi#listProjects");
            e.printStackTrace();
        }
    }
}



// Create an instance of the API class
ProjectsApi *apiInstance = [[ProjectsApi alloc] init];
UUID *campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; //  (optional) (default to null)

[apiInstance listProjectsWith:campaignId
              completionHandler: ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var KoalectPublicApi = require('koalect_public_api');

// Create an instance of the API class
var api = new KoalectPublicApi.ProjectsApi()
var opts = {
  'campaignId': 38400000-8cf0-11bd-b23e-10b96e4ef00d // {UUID} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listProjects(opts, callback);

using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listProjectsExample
    {
        public void main()
        {
            
            // Create an instance of the API class
            var apiInstance = new ProjectsApi();
            var campaignId = new UUID(); // UUID |  (optional)  (default to null)

            try {
                array[Object] result = apiInstance.listProjects(campaignId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ProjectsApi.listProjects: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ProjectsApi();
$campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | 

try {
    $result = $api_instance->listProjects($campaignId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProjectsApi->listProjects: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ProjectsApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ProjectsApi->new();
my $campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | 

eval { 
    my $result = $api_instance->listProjects(campaignId => $campaignId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProjectsApi->listProjects: $@\n";
}

from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ProjectsApi()
campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID |  (optional) (default to null)

try: 
    api_response = api_instance.list_projects(campaignId=campaignId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProjectsApi->listProjects: %s\n" % e)

extern crate ProjectsApi;

pub fn main() {
    let campaignId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID

    let mut context = ProjectsApi::Context::default();
    let result = client.listProjects(campaignId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters

Name	Description
campaign_id	UUID (uuid)

Responses

Schema

Koalect Public API

API and SDK Documentation

Campaigns

getCampaign

Usage and SDK Samples

Scopes

Parameters

Responses

listCampaigns

Usage and SDK Samples

Scopes

Parameters

Responses

Projects

getProject

Usage and SDK Samples

Scopes

Parameters

Responses

listProjectdonations

Usage and SDK Samples

Scopes

Parameters

Responses

listProjects

Usage and SDK Samples

Scopes

Parameters

Responses