Create a team

Arguments

Argument Required/optional Description
team_name required A string of the name of the new team
team_permission_own optional Either true or false depending on if you want to restrict this team to their own documents
team_permission_users optional Either true or false depending on if you want to restrict this team to manage users
team_permission_branding optional Either true or false depending on if you want to restrict this team to manage branding
team_permission_apps optional Either true or false depending on if you want to restrict this team to manage apps
team_permission_settings optional Either true or false depending on if you want to restrict this team to manage settings
team_permission_company optional Either true or false depending on if you want to restrict this team to manage company information, including billing details

Example Request

cURL

curl https://api.signable.co.uk/v1/teams \
   -u d41d8cd98f00b204e9800998ecf8427e:x \
   -X POST \
   -d "team_name=The A Team" \
   -d "team_permission_own=true" \
   -d "team_permission_apps=true"
		

PHP

// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$permissions = array( 'team_permission_own' => 'true', 'team_permission_apps' => 'true' );
$response = Signable\Teams::createNew( "The A Team", $permissions );
// Output the response
var_dump($response);
			

Example Response

{
    "http": 200,
    "message": "The A Team has been added to your teams with own documents only, apps permissions.",
    "href": "https://api.signable.co.uk/v1/teams/1000",
    "team_id": "1000",
    "team_name": "The A Team",
    "team_permission_own": true,
    "team_permission_users": false,
    "team_permission_branding": false,
    "team_permission_apps": true,
    "team_permission_settings": false,
    "team_permission_company": false,
    "team_created": "2015-01-21T12:03:00+0000"
}


Get a team

Arguments

Argument Required/optional Description
id required A positive integer representing the team_id

Example Request

cURL

curl https://api.signable.co.uk/v1/teams/1000
-u d41d8cd98f00b204e9800998ecf8427e:x
		

PHP


// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$response = Signable\Teams::getSingle(1000);
// Output the response
var_dump($response);
			

Example Response

{
    "http": 200,
    "team_id": 1000,
    "team_name": "The A Team",
    "team_users": "3",
    "team_permission_own": false,
    "team_permission_users": true,
    "team_permission_branding": true,
    "team_permission_apps": true,
    "team_permission_settings": true,
    "team_permission_company": true,
    "team_updated": null,
    "team_created": "2014-11-12T15:21:50+0000"
}


List teams

Arguments

Argument Required/optional Description
offset optional A positive integer indicating the first record to retrieve. Defaults to the first team.
limit optional A positive integer indicating the maximum number of teams to return. Defaults to 10.

Example Request

cURL

curl https://api.signable.co.uk/v1/teams?offset=0&limit=3
-u d41d8cd98f00b204e9800998ecf8427e:x
		

PHP


// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$response = Signable\Teams::getMultiple(0, 10);
// Output the response
var_dump($response);
			

Example Response

{
    "http": 200,
    "offset": 0,
    "limit": 3,
    "total_teams": "2",
    "teams": [
        {
            "team_id": "129",
            "team_name": "General",
            "team_users": "3",
            "team_permission_own": false,
            "team_permission_users": true,
            "team_permission_branding": true,
            "team_permission_apps": true,
            "team_permission_settings": true,
            "team_permission_company": true,
            "team_updated": null,
            "team_created": "2014-11-12T15:21:50+0000"
        },
	{
            "team_id": "1000",
            "team_name": "The A Team",
            "team_users": "5",
            "team_permission_own": false,
            "team_permission_users": true,
            "team_permission_branding": true,
            "team_permission_apps": true,
            "team_permission_settings": true,
            "team_permission_company": true,
            "team_updated": null,
            "team_created": "2014-11-12T15:21:50+0000"
        }
    ]
}


Update a team

Arguments

Argument Required/optional Description
id required A positive integer representing the team_id of the team you want to update
team_name required A string of the new name of the team.
team_permission_own optional Either true or false depending on if you want to restrict this team to their own documents
team_permission_users optional Either true or false depending on if you want to restrict this team to manage users
team_permission_branding optional Either true or false depending on if you want to restrict this team to manage branding
team_permission_apps optional Either true or false depending on if you want to restrict this team to manage apps
team_permission_settings optional Either true or false depending on if you want to restrict this team to manage settings
team_permission_company optional Either true or false depending on if you want to restrict this team to manage company information, including billing details

Example Request

cURL

curl https:/api.signable.co.uk/v1/teams/1000 \
   -u d41d8cd98f00b204e9800998ecf8427e:x \
   -X PUT \
   -d "team_name=The B Team" \
   -d "team_permission_own=false"
		

PHP


// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$permissions = array( 'team_permission_own' => 'false' );
$response = Signable\Teams::update(1000, "The B Team", $permissions)

// Output the response
var_dump($response);
			

Example Response


{
	"http":200,
	"message":"The B Team has been updated in your teams",
	"href":"https://api.signable.co.uk/v1/teams/1000",
	"team_id": 1000,
	"team_name": "The B Team",
	"team_users": "2",
	"team_permission_own": false,
	"team_permission_users": false,
	"team_permission_branding": false,
	"team_permission_apps": false,
	"team_permission_settings": false,
	"team_permission_company": false,
	"team_updated": "2015-01-21T11:57:29+0000"
}


Delete a team

Arguments

Argument Required/optional Description
id required A positive integer representing the team_id of the team you want to delete

Example Request

cURL

curl https://api.signable.co.uk/v1/teams/1000
   -u d41d8cd98f00b204e9800998ecf8427e:x 
   -X DELETE
		

PHP


// Download our PHP SDK Library here: https://github.com/Signable/signable-sdk-php
$response = Signable\Teams::delete(1000);
// Output the response
var_dump($response);
			

Example Response

{
    "http": 200,
    "message": "Test Add 2 has been removed from your teams.",
    "team_id": 1000,
    "team_name": "The B Team",
    "team_removed": "2015-01-21T11:59:03+0000"
}