Aptly API

Boards

addCard

Create or update a card on a board

Posts a new card to the board. The format of this post is a JSON object that contacts key/value pairs where the key is the NAME of the field (not the UUID), and the value is the value you wish to post. If an _id parameter is provided, Aptly will update the existing card that matches the given _id. Note that the JSON key for the field is the name of the field in this endpoint, not the uuid that you can retrieve in the schema. This may be changed in the future.

/aptlet/:boardId

Usage and SDK Samples

curl -X POST "https://app.getaptly.com/api/aptlet/:boardId?x-token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BoardsApi;

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

public class BoardsApiExample {

    public static void main(String[] args) {
        
        BoardsApi apiInstance = new BoardsApi();
        String xToken = xToken_example; // String | Your Aptly API Token
        CardPost data = ; // CardPost | Data for the card to post
        try {
            apiInstance.addCard(xToken, data);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#addCard");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BoardsApi;

public class BoardsApiExample {

    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        String xToken = xToken_example; // String | Your Aptly API Token
        CardPost data = ; // CardPost | Data for the card to post
        try {
            apiInstance.addCard(xToken, data);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#addCard");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API Token
CardPost *data = ; // Data for the card to post (optional)

BoardsApi *apiInstance = [[BoardsApi alloc] init];

// Create or update a card on a board
[apiInstance addCardWith:xToken
    data:data
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.BoardsApi()

var xToken = xToken_example; // {String} Your Aptly API Token

var opts = { 
  'data':  // {CardPost} Data for the card to post
};

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addCardExample
    {
        public void main()
        {
            
            var apiInstance = new BoardsApi();
            var xToken = xToken_example;  // String | Your Aptly API Token
            var data = new CardPost(); // CardPost | Data for the card to post (optional) 

            try
            {
                // Create or update a card on a board
                apiInstance.addCard(xToken, data);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BoardsApi.addCard: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\BoardsApi();
$xToken = xToken_example; // String | Your Aptly API Token
$data = ; // CardPost | Data for the card to post

try {
    $api_instance->addCard($xToken, $data);
} catch (Exception $e) {
    echo 'Exception when calling BoardsApi->addCard: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BoardsApi;

my $api_instance = WWW::SwaggerClient::BoardsApi->new();
my $xToken = xToken_example; # String | Your Aptly API Token
my $data = WWW::SwaggerClient::Object::CardPost->new(); # CardPost | Data for the card to post

eval { 
    $api_instance->addCard(xToken => $xToken, data => $data);
};
if ($@) {
    warn "Exception when calling BoardsApi->addCard: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.BoardsApi()
xToken = xToken_example # String | Your Aptly API Token
data =  # CardPost | Data for the card to post (optional)

try: 
    # Create or update a card on a board
    api_instance.add_card(xToken, data=data)
except ApiException as e:
    print("Exception when calling BoardsApi->addCard: %s\n" % e)

Parameters

Body parameters

Name	Description
data

Query parameters

Name	Description
x-token*	String Your Aptly API Token Required

Responses

Status: 200 - item created

Status: 400 - invalid input, object invalid

getCards

Returns a list of cards for a board

Returns cards on a board specified by board id. The URL with the board id is available in the Aptly UI under Card Sources -> API. API access must be turned on by a user with appropriate privileges for each board you wish to enable. When you enable the API, you will also be presented with your API Token/Key. The token must be passed in each request via an x-token query parameter. The token is company wide and can be reused if you are enabling multiple boards to have API access. Data is returned by page and the page size is 200. When there is no more data you will receive an empty array. Data is sorted by the time it was last updated, so if you are syncing data, you should crawl pages until you've got everything modified since your last data pull. A better approach is to use our webhook which will POST changes to a URL you provide whenever a change occurs the board in Aptly.

/aptlet/:boardId

Usage and SDK Samples

curl -X GET "https://app.getaptly.com/api/aptlet/:boardId?x-token=&page="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BoardsApi;

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

public class BoardsApiExample {

    public static void main(String[] args) {
        
        BoardsApi apiInstance = new BoardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        Integer page = 56; // Integer | The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page.
        try {
            array[Card] result = apiInstance.getCards(xToken, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getCards");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BoardsApi;

public class BoardsApiExample {

    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        Integer page = 56; // Integer | The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page.
        try {
            array[Card] result = apiInstance.getCards(xToken, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getCards");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token
Integer *page = 56; // The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page. (optional)

BoardsApi *apiInstance = [[BoardsApi alloc] init];

// Returns a list of cards for a board
[apiInstance getCardsWith:xToken
    page:page
              completionHandler: ^(array[Card] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.BoardsApi()

var xToken = xToken_example; // {String} Your Aptly API token

var opts = { 
  'page': 56 // {Integer} The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page.
};

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardsExample
    {
        public void main()
        {
            
            var apiInstance = new BoardsApi();
            var xToken = xToken_example;  // String | Your Aptly API token
            var page = 56;  // Integer | The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page. (optional) 

            try
            {
                // Returns a list of cards for a board
                array[Card] result = apiInstance.getCards(xToken, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BoardsApi.getCards: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\BoardsApi();
$xToken = xToken_example; // String | Your Aptly API token
$page = 56; // Integer | The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page.

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BoardsApi;

my $api_instance = WWW::SwaggerClient::BoardsApi->new();
my $xToken = xToken_example; # String | Your Aptly API token
my $page = 56; # Integer | The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page.

eval { 
    my $result = $api_instance->getCards(xToken => $xToken, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BoardsApi->getCards: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.BoardsApi()
xToken = xToken_example # String | Your Aptly API token
page = 56 # Integer | The page of results you want, 0 indexed.  Start at 0 and increment until your done receiving results in which case Aptly will send an empty array.  Results returned ordered by last modified date. Page size is 200 items per page. (optional)

try: 
    # Returns a list of cards for a board
    api_response = api_instance.get_cards(xToken, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BoardsApi->getCards: %s\n" % e)

Parameters

Query parameters

Name	Description
x-token*	String Your Aptly API token Required
page	Integer (int32) The page of results you want, 0 indexed. Start at 0 and increment until your done receiving results in which case Aptly will send an empty array. Results returned ordered by last modified date. Page size is 200 items per page.

Responses

Status: 200 - card results

Schema

Status: 400 - bad input parameter

getSchema

Returns the board schema

Returns the field schema for the board.

/schema/:boardId

Usage and SDK Samples

curl -X GET "https://app.getaptly.com/api/schema/:boardId?x-token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BoardsApi;

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

public class BoardsApiExample {

    public static void main(String[] args) {
        
        BoardsApi apiInstance = new BoardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        try {
            array[BoardSchema] result = apiInstance.getSchema(xToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getSchema");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.BoardsApi;

public class BoardsApiExample {

    public static void main(String[] args) {
        BoardsApi apiInstance = new BoardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        try {
            array[BoardSchema] result = apiInstance.getSchema(xToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BoardsApi#getSchema");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token

BoardsApi *apiInstance = [[BoardsApi alloc] init];

// Returns the board schema
[apiInstance getSchemaWith:xToken
              completionHandler: ^(array[BoardSchema] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.BoardsApi()

var xToken = xToken_example; // {String} Your Aptly API token


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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSchemaExample
    {
        public void main()
        {
            
            var apiInstance = new BoardsApi();
            var xToken = xToken_example;  // String | Your Aptly API token

            try
            {
                // Returns the board schema
                array[BoardSchema] result = apiInstance.getSchema(xToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BoardsApi.getSchema: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\BoardsApi();
$xToken = xToken_example; // String | Your Aptly API token

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BoardsApi;

my $api_instance = WWW::SwaggerClient::BoardsApi->new();
my $xToken = xToken_example; # String | Your Aptly API token

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

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

# create an instance of the API class
api_instance = swagger_client.BoardsApi()
xToken = xToken_example # String | Your Aptly API token

try: 
    # Returns the board schema
    api_response = api_instance.get_schema(xToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BoardsApi->getSchema: %s\n" % e)

Parameters

Query parameters

Name	Description
x-token*	String Your Aptly API token Required

Responses

Status: 200 - board schema

Schema

Status: 400 - bad input parameter

Cards

getCard

Returns the specific card based on the id

Returns the card data

/card/:cardId

Usage and SDK Samples

curl -X GET "https://app.getaptly.com/api/card/:cardId?x-token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardsApi;

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

public class CardsApiExample {

    public static void main(String[] args) {
        
        CardsApi apiInstance = new CardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        try {
            array[Card] result = apiInstance.getCard(xToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#getCard");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CardsApi;

public class CardsApiExample {

    public static void main(String[] args) {
        CardsApi apiInstance = new CardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        try {
            array[Card] result = apiInstance.getCard(xToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#getCard");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token

CardsApi *apiInstance = [[CardsApi alloc] init];

// Returns the specific card based on the id
[apiInstance getCardWith:xToken
              completionHandler: ^(array[Card] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.CardsApi()

var xToken = xToken_example; // {String} Your Aptly API token


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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCardExample
    {
        public void main()
        {
            
            var apiInstance = new CardsApi();
            var xToken = xToken_example;  // String | Your Aptly API token

            try
            {
                // Returns the specific card based on the id
                array[Card] result = apiInstance.getCard(xToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardsApi.getCard: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\CardsApi();
$xToken = xToken_example; // String | Your Aptly API token

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardsApi;

my $api_instance = WWW::SwaggerClient::CardsApi->new();
my $xToken = xToken_example; # String | Your Aptly API token

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

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

# create an instance of the API class
api_instance = swagger_client.CardsApi()
xToken = xToken_example # String | Your Aptly API token

try: 
    # Returns the specific card based on the id
    api_response = api_instance.get_card(xToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardsApi->getCard: %s\n" % e)

Parameters

Query parameters

Name	Description
x-token*	String Your Aptly API token Required

Responses

Status: 200 - card data

Schema

Status: 400 - bad input parameter

postComment

Posts a comment to a card

Usage and SDK Samples

curl -X POST "https://app.getaptly.com/api/card/:cardId/comment?x-token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardsApi;

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

public class CardsApiExample {

    public static void main(String[] args) {
        
        CardsApi apiInstance = new CardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        PostComment data = ; // PostComment | Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment.
        try {
            Comment result = apiInstance.postComment(xToken, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#postComment");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CardsApi;

public class CardsApiExample {

    public static void main(String[] args) {
        CardsApi apiInstance = new CardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        PostComment data = ; // PostComment | Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment.
        try {
            Comment result = apiInstance.postComment(xToken, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#postComment");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token
PostComment *data = ; // Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment. (optional)

CardsApi *apiInstance = [[CardsApi alloc] init];

// Posts a comment to a card
[apiInstance postCommentWith:xToken
    data:data
              completionHandler: ^(Comment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.CardsApi()

var xToken = xToken_example; // {String} Your Aptly API token

var opts = { 
  'data':  // {PostComment} Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment.
};

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postCommentExample
    {
        public void main()
        {
            
            var apiInstance = new CardsApi();
            var xToken = xToken_example;  // String | Your Aptly API token
            var data = new PostComment(); // PostComment | Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment. (optional) 

            try
            {
                // Posts a comment to a card
                Comment result = apiInstance.postComment(xToken, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardsApi.postComment: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\CardsApi();
$xToken = xToken_example; // String | Your Aptly API token
$data = ; // PostComment | Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment.

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardsApi;

my $api_instance = WWW::SwaggerClient::CardsApi->new();
my $xToken = xToken_example; # String | Your Aptly API token
my $data = WWW::SwaggerClient::Object::PostComment->new(); # PostComment | Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment.

eval { 
    my $result = $api_instance->postComment(xToken => $xToken, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardsApi->postComment: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.CardsApi()
xToken = xToken_example # String | Your Aptly API token
data =  # PostComment | Data for the comment to post.  If you pass a comment id, the comment content for that comment will be updated.  leave off id for a new comment. (optional)

try: 
    # Posts a comment to a card
    api_response = api_instance.post_comment(xToken, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardsApi->postComment: %s\n" % e)

Parameters

Body parameters

Name	Description
data

Query parameters

Name	Description
x-token*	String Your Aptly API token Required

Responses

Status: 200 - comment data

Schema

Status: 400 - bad input parameter

postFile

Posts a file to a card

Post a file to a card instance

/card/:cardId/file

Usage and SDK Samples

curl -X POST "https://app.getaptly.com/api/card/:cardId/file?x-token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CardsApi;

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

public class CardsApiExample {

    public static void main(String[] args) {
        
        CardsApi apiInstance = new CardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        PostFile data = ; // PostFile | Data for the file including base64 encoding of the bytes.
        try {
            File result = apiInstance.postFile(xToken, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#postFile");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CardsApi;

public class CardsApiExample {

    public static void main(String[] args) {
        CardsApi apiInstance = new CardsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        PostFile data = ; // PostFile | Data for the file including base64 encoding of the bytes.
        try {
            File result = apiInstance.postFile(xToken, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CardsApi#postFile");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token
PostFile *data = ; // Data for the file including base64 encoding of the bytes. (optional)

CardsApi *apiInstance = [[CardsApi alloc] init];

// Posts a file to a card
[apiInstance postFileWith:xToken
    data:data
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.CardsApi()

var xToken = xToken_example; // {String} Your Aptly API token

var opts = { 
  'data':  // {PostFile} Data for the file including base64 encoding of the bytes.
};

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postFileExample
    {
        public void main()
        {
            
            var apiInstance = new CardsApi();
            var xToken = xToken_example;  // String | Your Aptly API token
            var data = new PostFile(); // PostFile | Data for the file including base64 encoding of the bytes. (optional) 

            try
            {
                // Posts a file to a card
                File result = apiInstance.postFile(xToken, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CardsApi.postFile: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\CardsApi();
$xToken = xToken_example; // String | Your Aptly API token
$data = ; // PostFile | Data for the file including base64 encoding of the bytes.

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CardsApi;

my $api_instance = WWW::SwaggerClient::CardsApi->new();
my $xToken = xToken_example; # String | Your Aptly API token
my $data = WWW::SwaggerClient::Object::PostFile->new(); # PostFile | Data for the file including base64 encoding of the bytes.

eval { 
    my $result = $api_instance->postFile(xToken => $xToken, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CardsApi->postFile: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.CardsApi()
xToken = xToken_example # String | Your Aptly API token
data =  # PostFile | Data for the file including base64 encoding of the bytes. (optional)

try: 
    # Posts a file to a card
    api_response = api_instance.post_file(xToken, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CardsApi->postFile: %s\n" % e)

Parameters

Body parameters

Name	Description
data

Query parameters

Name	Description
x-token*	String Your Aptly API token Required

Responses

Status: 200 - file data

Schema

Status: 400 - bad input parameter

Contacts

getContacts

Returns contacts

Returns the contacts for the Aptly account

/contact

Usage and SDK Samples

curl -X GET "https://app.getaptly.com/api/contact?x-token=&page="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

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

public class ContactsApiExample {

    public static void main(String[] args) {
        
        ContactsApi apiInstance = new ContactsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        BigDecimal page = 8.14; // BigDecimal | The page number
        try {
            array[Contact] result = apiInstance.getContacts(xToken, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContacts");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        BigDecimal page = 8.14; // BigDecimal | The page number
        try {
            array[Contact] result = apiInstance.getContacts(xToken, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#getContacts");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token
BigDecimal *page = 8.14; // The page number

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Returns contacts
[apiInstance getContactsWith:xToken
    page:page
              completionHandler: ^(array[Contact] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.ContactsApi()

var xToken = xToken_example; // {String} Your Aptly API token

var page = 8.14; // {BigDecimal} The page number


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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getContactsExample
    {
        public void main()
        {
            
            var apiInstance = new ContactsApi();
            var xToken = xToken_example;  // String | Your Aptly API token
            var page = 8.14;  // BigDecimal | The page number

            try
            {
                // Returns contacts
                array[Contact] result = apiInstance.getContacts(xToken, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.getContacts: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\ContactsApi();
$xToken = xToken_example; // String | Your Aptly API token
$page = 8.14; // BigDecimal | The page number

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $xToken = xToken_example; # String | Your Aptly API token
my $page = 8.14; # BigDecimal | The page number

eval { 
    my $result = $api_instance->getContacts(xToken => $xToken, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->getContacts: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
xToken = xToken_example # String | Your Aptly API token
page = 8.14 # BigDecimal | The page number

try: 
    # Returns contacts
    api_response = api_instance.get_contacts(xToken, page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->getContacts: %s\n" % e)

Parameters

Query parameters

Name	Description
x-token*	String Your Aptly API token Required
page*	BigDecimal The page number Required

Responses

Status: 200 - file data

Schema

Status: 400 - bad input parameter

postContact

Posts a contact

Post a contact

/contact

Usage and SDK Samples

curl -X POST "https://app.getaptly.com/api/contact?x-token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

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

public class ContactsApiExample {

    public static void main(String[] args) {
        
        ContactsApi apiInstance = new ContactsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        Contact data = ; // Contact | Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created.
        try {
            Contact result = apiInstance.postContact(xToken, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#postContact");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        String xToken = xToken_example; // String | Your Aptly API token
        Contact data = ; // Contact | Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created.
        try {
            Contact result = apiInstance.postContact(xToken, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#postContact");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token
Contact *data = ; // Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created. (optional)

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Posts a contact
[apiInstance postContactWith:xToken
    data:data
              completionHandler: ^(Contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.ContactsApi()

var xToken = xToken_example; // {String} Your Aptly API token

var opts = { 
  'data':  // {Contact} Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created.
};

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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postContactExample
    {
        public void main()
        {
            
            var apiInstance = new ContactsApi();
            var xToken = xToken_example;  // String | Your Aptly API token
            var data = new Contact(); // Contact | Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created. (optional) 

            try
            {
                // Posts a contact
                Contact result = apiInstance.postContact(xToken, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.postContact: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\ContactsApi();
$xToken = xToken_example; // String | Your Aptly API token
$data = ; // Contact | Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created.

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $xToken = xToken_example; # String | Your Aptly API token
my $data = WWW::SwaggerClient::Object::Contact->new(); # Contact | Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created.

eval { 
    my $result = $api_instance->postContact(xToken => $xToken, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->postContact: $@\n";
}

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

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
xToken = xToken_example # String | Your Aptly API token
data =  # Contact | Data for the contact.  If an _id value is passed in the post data, the corresponding contact will be updated.  If no _id is passed, a new contact will be created. (optional)

try: 
    # Posts a contact
    api_response = api_instance.post_contact(xToken, data=data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->postContact: %s\n" % e)

Parameters

Body parameters

Name	Description
data

Query parameters

Name	Description
x-token*	String Your Aptly API token Required

Responses

Status: 200 - contact data

Schema

Status: 400 - bad input parameter

Users

getUsers

Returns the Aptly user accounts for the company

Returns the users for the Aptly account

/users

Usage and SDK Samples

curl -X GET "https://app.getaptly.com/api/users?x-token="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    public static void main(String[] args) {
        
        UsersApi apiInstance = new UsersApi();
        String xToken = xToken_example; // String | Your Aptly API token
        try {
            array[User] result = apiInstance.getUsers(xToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String xToken = xToken_example; // String | Your Aptly API token
        try {
            array[User] result = apiInstance.getUsers(xToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}

String *xToken = xToken_example; // Your Aptly API token

UsersApi *apiInstance = [[UsersApi alloc] init];

// Returns the Aptly user accounts for the company
[apiInstance getUsersWith:xToken
              completionHandler: ^(array[User] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var AptlyApi = require('aptly_api');

var api = new AptlyApi.UsersApi()

var xToken = xToken_example; // {String} Your Aptly API token


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

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUsersExample
    {
        public void main()
        {
            
            var apiInstance = new UsersApi();
            var xToken = xToken_example;  // String | Your Aptly API token

            try
            {
                // Returns the Aptly user accounts for the company
                array[User] result = apiInstance.getUsers(xToken);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getUsers: " + e.Message );
            }
        }
    }
}

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

$api_instance = new Swagger\Client\Api\UsersApi();
$xToken = xToken_example; // String | Your Aptly API token

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

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UsersApi;

my $api_instance = WWW::SwaggerClient::UsersApi->new();
my $xToken = xToken_example; # String | Your Aptly API token

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

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

# create an instance of the API class
api_instance = swagger_client.UsersApi()
xToken = xToken_example # String | Your Aptly API token

try: 
    # Returns the Aptly user accounts for the company
    api_response = api_instance.get_users(xToken)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getUsers: %s\n" % e)

Parameters

Query parameters

Name	Description
x-token*	String Your Aptly API token Required

Responses

Status: 200 - file data

Schema

Customer Support

Aptly API

API and SDK Documentation

Boards

addCard

Usage and SDK Samples

Parameters

Responses

Status: 200 - item created

Status: 400 - invalid input, object invalid

getCards

Usage and SDK Samples

Parameters

Responses

Status: 200 - card results

Status: 400 - bad input parameter

getSchema

Usage and SDK Samples

Parameters

Responses

Status: 200 - board schema

Status: 400 - bad input parameter

Cards

getCard

Usage and SDK Samples

Parameters

Responses

Status: 200 - card data

Status: 400 - bad input parameter

postComment

Usage and SDK Samples

Parameters

Responses

Status: 200 - comment data

Status: 400 - bad input parameter

postFile

Usage and SDK Samples

Parameters

Responses

Status: 200 - file data

Status: 400 - bad input parameter

Contacts

getContacts

Usage and SDK Samples

Parameters

Responses

Status: 200 - file data

Status: 400 - bad input parameter

postContact

Usage and SDK Samples

Parameters

Responses

Status: 200 - contact data

Status: 400 - bad input parameter

Users

getUsers

Usage and SDK Samples

Parameters

Responses

Status: 200 - file data

Status: 400 - bad input parameter