Accelo
Accelo is an end-to-end cloud-based platform that manages all aspects of client work delivery. The Accelo Connector help Companies connect their client projects with Turbine, enabling them with automation in different aspects of project management including contracts, implementations, and custom profile values. Additionally, using the Accelo connector, you can create accounts and contacts, activate and deactivate accounts, retrieve and update contracts, profile values, and more within the Accelo platform.
Prerequisites
A valid Accelo account with admin privileges is required
Capabilities
Accelo Connector provides the following capabilities:
- Retrive ,create and update accounts
- Retrive and filter contracts
- Activate and deactivate the accounts
- Retrive and update custom profile values
- Create contacts with company link
Asset Setup
Before doing anything, you will need to register your application with Accelo. This is done from your deployment under "Configuration" β "API" β "Register Application". Accelo currently offers three types of applications:
Installed Application Web Application Service Application
Note: An application can only be registered with one type. If your application requires multiple types you will need to register multiple applications
Once registered, your application will be given a client_id and client_secret, which are required to authenticate.
Authentication will require :
client_id client_secret Deployment/base url Token_url
Notes
- Accelo Api Documentation : https://api.accelo.com/docs
Additional Documentation
Configurations
Auth Client Credentials
Authenticates using client credentials
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Required |
token_url | ο»Ώ | string | Required |
client_id | The client ID | string | Required |
client_secret | The client secret. | string | Required |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
Actions
Activate Account
Set account status to active
Endpoint
- URL: api/v0/companies/{{accelo_id}}/progressions/6/auto
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.accelo_id | string | Optional | Parameters for the Activate Account action |
Input Example
{"path_parameters":{"accelo_id":"3653"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response | object | Output field: response |
response.id | string | Unique identifier |
response.name | string | Name of the resource |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.status | string | Status value |
meta.more_info | string | Output field: meta.more_info |
Output Example
{"status_code":200,"response_headers":{"Date":"Fri, 21 Jul 2023 04:14:06 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"181","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4996","X-RateLimit-Reset":"1689916124","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"response":{"id":"3653","name":"Turbine Playbook test"},"meta":{"message":"Everything executed as exp...
Create Account
Create an account in accelo
Endpoint
- URL: api/v0/companies
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
name | string | Optional | Name of the resource |
status_id | string | Optional | Unique identifier |
comments | string | Optional | Parameter for Create Account |
custom_id | string | Optional | Unique identifier |
website | string | Optional | Parameter for Create Account |
Input Example
{"json_body":{"name":"Connector Test 1","status_id":"7","comments":"testoing Connector","custom_id":"111111","website":"turbineconnector.com"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.more_info | string | Output field: meta.more_info |
meta.status | string | Status value |
response | object | Output field: response |
response.id | string | Unique identifier |
response.name | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{"Date":"Fri, 21 Jul 2023 03:03:17 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"176","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4999","X-RateLimit-Reset":"1689912196","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"meta":{"message":"Everything executed as expected.","more_info":"https://api.accelo.com/docs/#status...
Create Contact
Create a contact
Endpoint
- URL: /api/v0/contacts
- Method: POST
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
company_id | string | Optional | Unique identifier |
firstname | string | Optional | Name of the resource |
surname | string | Optional | Name of the resource |
string | Optional | Parameter for Create Contact | |
comments | string | Optional | Parameter for Create Contact |
phone | number | Optional | Parameter for Create Contact |
username | string | Optional | Name of the resource |
middlename | string | Optional | Unique identifier |
title | string | Optional | Parameter for Create Contact |
timezone | string | Optional | Parameter for Create Contact |
position | string | Optional | Parameter for Create Contact |
Input Example
{"json_body":{"company_id":"3654","firstname":"dummy","surname":"mohammed","email":"[email protected]","comments":"something","phone":1234567890,"username":"mab","middlename":"baseer","title":"Mr","timezone":"mst","position":"intern"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.status | string | Status value |
meta.more_info | string | Output field: meta.more_info |
response | object | Output field: response |
response.mobile | string | Output field: response.mobile |
response.surname | string | Name of the resource |
response.firstname | string | Name of the resource |
response.email | string | Output field: response.email |
response.id | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{"Date":"Mon, 24 Jul 2023 20:57:27 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"232","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4998","X-RateLimit-Reset":"1690235556","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"meta":{"message":"Everything executed as expected.","status":"ok","more_info":"https://api.accelo.co...
Deactivate Account
Deactivate an accelo account
Endpoint
- URL: api/v0/companies/{{accelo_id}}/progressions/8/auto
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.accelo_id | string | Required | Parameters for the Deactivate Account action |
Input Example
{"path_parameters":{"accelo_id":"3653"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response | object | Output field: response |
response.name | string | Name of the resource |
response.id | string | Unique identifier |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.status | string | Status value |
meta.more_info | string | Output field: meta.more_info |
Output Example
{"status_code":200,"response_headers":{"Date":"Fri, 21 Jul 2023 04:13:16 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"181","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4997","X-RateLimit-Reset":"1689916124","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"response":{"name":"Turbine Playbook test","id":"3653"},"meta":{"message":"Everything executed as exp...
Get Accounts
get all acounts from accelo (limit 100 accounts)
Endpoint
- URL: api/v0/companies
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters._limit | string | Optional | Parameters for the Get Accounts action |
parameters._fields | string | Optional | Parameters for the Get Accounts action |
parameters._offset | string | Optional | Parameters for the Get Accounts action |
parameters._filters | string | Optional | Parameters for the Get Accounts action |
Input Example
{"parameters":{"_limit":"100","_fields":"_ALL","_offset":"","_filters":"custom_id(12345)"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.status | string | Status value |
meta.more_info | string | Output field: meta.more_info |
meta.warnings | array | Output field: meta.warnings |
response | array | Output field: response |
response.standing | string | Output field: response.standing |
response.date_created | string | Output field: response.date_created |
response.custom_id | string | Unique identifier |
response.phone | object | Output field: response.phone |
response.name | string | Name of the resource |
response.website | string | Output field: response.website |
response.status | string | Status value |
response.company_status | string | Status value |
response.comments | object | Output field: response.comments |
response.postal_address | string | Output field: response.postal_address |
response.default_affiliation | string | Output field: response.default_affiliation |
response.id | string | Unique identifier |
response.date_last_interacted | string | Output field: response.date_last_interacted |
response.staff_bookmarked | string | Output field: response.staff_bookmarked |
response.fax | object | Output field: response.fax |
response.date_modified | string | Output field: response.date_modified |
Output Example
{"status_code":200,"response_headers":{"Date":"Wed, 26 Jul 2023 12:25:46 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"639","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4998","X-RateLimit-Reset":"1690377857","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"meta":{"message":"Everything executed as expected.","status":"ok","more_info":"https://api.accelo.co...
Get Contract periods
Get contract periods by contract ID
Endpoint
- URL: api/v0/contracts/{{contract_id}}/periods
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.contract_id | string | Required | Parameters for the Get Contract periods action |
parameters._limit | number | Optional | Parameters for the Get Contract periods action |
parameters._fields | string | Optional | Parameters for the Get Contract periods action |
Input Example
{"parameters":{"_limit":100,"_fields":"_ALL"},"path_parameters":{"contract_id":"113"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response | object | Output field: response |
response.periods | array | Output field: response.periods |
response.periods.allowance_type | string | Type of the resource |
response.periods.on_budget | number | Output field: response.periods.on_budget |
response.periods.budget_type | string | Type of the resource |
response.periods.contract_budget | string | Output field: response.periods.contract_budget |
response.periods.allowance | object | Output field: response.periods.allowance |
response.periods.allowance.charged | string | Output field: response.periods.allowance.charged |
response.periods.allowance.billable | string | Output field: response.periods.allowance.billable |
response.periods.time_allocations | array | Output field: response.periods.time_allocations |
response.periods.time_allocations.nonbillable | string | Output field: response.periods.time_allocations.nonbillable |
response.periods.time_allocations.period_id | string | Unique identifier |
response.periods.time_allocations.charged | string | Output field: response.periods.time_allocations.charged |
response.periods.time_allocations.against_type | string | Type of the resource |
response.periods.time_allocations.against_id | string | Unique identifier |
response.periods.time_allocations.against_title | string | Output field: response.periods.time_allocations.against_title |
response.periods.time_allocations.billable | string | Output field: response.periods.time_allocations.billable |
response.periods.overflow | number | Output field: response.periods.overflow |
response.periods.duration_type | string | Type of the resource |
response.periods.unapproved_budget_used | string | Output field: response.periods.unapproved_budget_used |
response.periods.standing | string | Output field: response.periods.standing |
response.periods.total | string | Output field: response.periods.total |
response.periods.contract_id | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{"Date":"Sun, 23 Jul 2023 03:01:31 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"1155","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4999","X-RateLimit-Reset":"1690084891","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"response":{"periods":[]},"meta":{"message":"Everything executed as expected.","status":"ok","more_i...
Get Contracts
Get contracts from accelo
Endpoint
- URL: api/v0/contracts
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters._limit | string | Optional | Parameters for the Get Contracts action |
parameters._fields | string | Optional | Parameters for the Get Contracts action |
parameters._filters | string | Optional | Parameters for the Get Contracts action |
Input Example
{"parameters":{"_limit":"100","_fields":"_ALL","_filters":"against_id(3029)"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response | array | Output field: response |
response.staff_bookmarked | string | Output field: response.staff_bookmarked |
response.auto_renew | string | Output field: response.auto_renew |
response.billable | string | Output field: response.billable |
response.affiliation | string | Output field: response.affiliation |
response.manager | string | Output field: response.manager |
response.job | object | Output field: response.job |
response.standing | string | Output field: response.standing |
response.contract_status | string | Status value |
response.send_invoice | string | Output field: response.send_invoice |
response.type | string | Type of the resource |
response.value | string | Value for the parameter |
response.date_started | string | Output field: response.date_started |
response.against_type | string | Type of the resource |
response.id | string | Unique identifier |
response.owner_affiliation | string | Output field: response.owner_affiliation |
response.against_id | string | Unique identifier |
response.date_last_interacted | object | Output field: response.date_last_interacted |
response.title | string | Output field: response.title |
response.against | string | Output field: response.against |
response.renew_days | string | Output field: response.renew_days |
response.date_created | string | Output field: response.date_created |
response.date_period_expires | string | Output field: response.date_period_expires |
Output Example
{"status_code":200,"response_headers":{"Date":"Sun, 23 Jul 2023 02:53:06 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"1345","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4241","X-RateLimit-Reset":"1690081206","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"response":[{}],"meta":{"message":"Everything executed as expected.","warnings":[],"status":"ok","mo...
Get profile Fields
Get all profile fields in accelo
Endpoint
- URL: api/v0/companies/profiles/fields
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
parameters._limit | number | Optional | Parameters for the Get profile Fields action |
parameters._fields | string | Optional | Parameters for the Get profile Fields action |
Input Example
{"parameters":{"_limit":100,"_fields":"_ALL"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response | array | Output field: response |
response.restrictions | string | Output field: response.restrictions |
response.lookup_type | object | Type of the resource |
response.field_type | string | Type of the resource |
response.exported | string | Output field: response.exported |
response.required | string | Output field: response.required |
response.description | object | Output field: response.description |
response.confidential | string | Unique identifier |
response.id | string | Unique identifier |
response.parent_id | string | Unique identifier |
response.field_name | string | Name of the resource |
response.link_type | string | Type of the resource |
response.options | array | Output field: response.options |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.status | string | Status value |
meta.more_info | string | Output field: meta.more_info |
Output Example
{"status_code":200,"response_headers":{"Date":"Thu, 27 Jul 2023 19:16:37 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"4364","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4999","X-RateLimit-Reset":"1690488997","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"response":[{"restrictions":"all","lookup_type":null,"field_type":"multi_select","exported":"yes","r...
Get Profile Values
get profile values of an account
Endpoint
- URL: api/v0/companies/{{accelo_id}}/profiles/values
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.accelo_id | string | Required | Parameters for the Get Profile Values action |
parameters._limit | number | Optional | Parameters for the Get Profile Values action |
parameters._fields | string | Optional | Parameters for the Get Profile Values action |
Input Example
{"parameters":{"_limit":100,"_fields":"_ALL"},"path_parameters":{"accelo_id":"2638"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response | array | Output field: response |
response.link_id | string | Unique identifier |
response.field_id | string | Unique identifier |
response.id | string | Unique identifier |
response.value_type | object | Type of the resource |
response.field_type | string | Type of the resource |
response.value | string | Value for the parameter |
response.modified_by | string | Output field: response.modified_by |
response.date_modified | string | Output field: response.date_modified |
response.link_type | string | Type of the resource |
response.field_name | string | Name of the resource |
response.values | array | Value for the parameter |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.status | string | Status value |
meta.more_info | string | Output field: meta.more_info |
Output Example
{"status_code":200,"response_headers":{"Date":"Fri, 21 Jul 2023 15:06:38 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"1236","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4999","X-RateLimit-Reset":"1689955598","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"response":[{"link_id":"2638","field_id":"12","id":"20","value_type":null,"field_type":"select","val...
Update Account
Update an account in accelo
Endpoint
- URL: api/v0/companies/{{accelo_id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.accelo_id | string | Required | Parameters for the Update Account action |
name | string | Optional | Name of the resource |
fax | string | Optional | Parameter for Update Account |
phone | number | Optional | Parameter for Update Account |
comments | string | Optional | Parameter for Update Account |
website | string | Optional | Parameter for Update Account |
Input Example
{"json_body":{"name":"Connector Test update","fax":"121212121","phone":7854238596,"comments":"some comment","website":"updatewebsite.com"},"path_parameters":{"accelo_id":"3654"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
response | object | Output field: response |
response.id | string | Unique identifier |
response.name | string | Name of the resource |
meta | object | Output field: meta |
meta.more_info | string | Output field: meta.more_info |
meta.status | string | Status value |
meta.message | string | Response message |
Output Example
{"status_code":200,"response_headers":{"Date":"Fri, 21 Jul 2023 03:08:17 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"181","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4998","X-RateLimit-Reset":"1689912196","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"response":{"id":"3654","name":"Connector Test update"},"meta":{"more_info":"https://api.accelo.com/d...
Update Profile Value
Update specific profile value of an accelo account
Endpoint
- URL: api/v0/companies/{{accelo_id}}/profiles/values/{{value_id}}
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
path_parameters.accelo_id | string | Required | Parameters for the Update Profile Value action |
path_parameters.value_id | string | Required | Parameters for the Update Profile Value action |
value | string | Optional | Value for the parameter |
Input Example
{"json_body":{"value":"DEV"},"path_parameters":{"accelo_id":"2638","value_id":"864"}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
meta | object | Output field: meta |
meta.message | string | Response message |
meta.status | string | Status value |
meta.more_info | string | Output field: meta.more_info |
response | object | Output field: response |
response.id | string | Unique identifier |
response.value_type | object | Type of the resource |
response.value | string | Value for the parameter |
response.field_type | string | Type of the resource |
response.values | array | Value for the parameter |
response.field_name | string | Name of the resource |
Output Example
{"status_code":200,"response_headers":{"Date":"Fri, 21 Jul 2023 15:19:17 GMT","Content-Type":"application/json; charset=utf-8","Content-Length":"261","Connection":"keep-alive","Server":"nginx","Access-Control-Allow-Origin":"*","X-RateLimit-Limit":"5000","X-RateLimit-Remaining":"4998","X-RateLimit-Reset":"1689955598","X-Status-Reason":"Everything executed as expected."},"reason":"OK","json_body":{"meta":{"message":"Everything executed as expected.","status":"ok","more_info":"https://api.accelo.co...
Response Headers
Header | Description | Example |
|---|---|---|
Access-Control-Allow-Origin | HTTP response header: Access-Control-Allow-Origin | * |
Connection | HTTP response header: Connection | keep-alive |
Content-Length | The length of the response body in bytes | 4364 |
Content-Type | The media type of the resource | application/json; charset=utf-8 |
Date | The date and time at which the message was originated | Fri, 21 Jul 2023 03:03:17 GMT |
Server | Information about the software used by the origin server | nginx |
X-RateLimit-Limit | The number of requests allowed in the current rate limit window | 5000 |
X-RateLimit-Remaining | The number of requests remaining in the current rate limit window | 4999 |
X-RateLimit-Reset | The time at which the current rate limit window resets | 1690081206 |
X-Status-Reason | HTTP response header: X-Status-Reason | Everything executed as expected. |