Productive V2 API

API Endpoint

This api is implemented according to JSON API spec.


API Endpoint

The latest API endpoint is https://api.productive.io/api/v2


Content Negotiation

Content-Type header must be set to application/vnd.api+json.

While sending bulk requests, make sure to set Content-Type to application/vnd.api+json; ext=bulk.

When Content-Type is not set as described, API will return 415 response status error.


Authorization

Most resources have authorization on them. If successfully authorized, you will get a response containing the resource; however, if you aren’t authorized then you will be given HTTP status of 401, and an error message.


Authentication

To authenticate yourself, add your API token to the X-Auth-Token header for every request.

To access your organization data, add your organzation ID to the X-Organization-Id header for every request.


Pagination

Pagination has to be set in the following style:

?page[number]=2&page[size]=20

Where page[number]= is the page you want to view, and page[size]= is the number of resources you want to return.


Filtering

If you would like to add filtration to your query, you can do that by setting the supported filter parameters in the following way: ?filter[person_id]=24. In case you set filter parameter that is not supported for the query, you will get 400 status error:

{
    "errors": [
        {
            "status": 400,
            "title": "Unsupported Filter",
            "detail": "Filter 'undefined' is not supported on this endpoint"
        }
    ]
}

Sorting

To sort query results, you can use sort parameter, passing available sort params for the resource: ?sort=name. All available sort params are defined separately for each resource. You can provide desired sort order using - sign (?sort=-name), where no - defines ascending and - defines descending order by the given sort parameter. If a given parameter is not supported, Unsupported Sort error (with status 400) will be raised:

{
    "errors": [
        {
            "status": 400,
            "title": "Unsupported Sort",
            "detail": "Sort by 'unsupported' is not supported on this endpoint"
        }
    ]
}

Aggregation

Some endpoints have available ?aggregates param. All available aggregation params are listed under each resource. In the case when aggregates param is present in the query, meta property of the response will include aggregates property with requested fields included (if available). If a given parameter is not available for the resource, Unsupported Aggregate error will be raised:

{
    "errors": [
        {
            "status": 400,
            "title": "Unsupported Aggregate",
            "detail": "Aggregate 'unavailable' is not supported on this endpoint"
        }
    ]
}

Errors

400

Used when a given query param is not supported. Possible title values: Unsupported Filter, Unsupported Filter Value, Unsupported Sort, Unsupported Aggregate, Unsupported Group

{
    "errors": [
        {
            "status": 400,
            "title": "*one of listed values*",
            "detail": "*...* is not supported on this endpoint"
        }
    ]
}

401

{
    "errors": [
        {
            "status": 401,
            "title": "Unauthenticated",
            "detail": "You are not authenticated"
        }
    ]
}

403

{
    "errors": [
        {
            "status": 403,
            "title": "Access Denied",
            "detail": "You are not authorized to access this resource"
        }
    ]
}

404

{
    "errors": [
        {
            "status": 404,
            "title": "Record Not Found",
            "detail": "The requested record was not found"
        }
    ]
}

406

{
    "errors": [
        {
            "status": 406,
            "title": "Not Acceptable",
            "detail": "The request was not accepted"
        }
    ]
}

415

{
    "errors": [
        {
            "status": 415,
            "title": "Unsupported Media Type",
            "detail": "Unsupported content type"
        }
    ]
}

422

{
    "errors": [
        {
            "status": 422,
            "title": "Invalid Attribute",
            "detail": "Unsupported content type"
        }
    ]
}

500

{
    "errors": [
        {
            "status": 500,
            "title": "Server Error",
            "detail": "An error occured on the server"
        }
    ]
}


Activities

Activities

Supported filter params

  • task_id

  • project_id

  • deal_id

  • invoice_id

  • company_id

  • person_id

  • creator_id

  • pinned

  • has_attachments

  • parent_type (1: Comment, 2: Changeset, 3: Email)

  • root_type (1: Comment, 2: Changeset, 3: Email)

  • after

  • before

GET /api/v2/activities
Requestsreturns activities

GET  /api/v2/activities?filter[task_id]=203

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "13",
      "type": "activities",
      "attributes": {
        "event": "create",
        "changes": "",
        "changeset": [],
        "item_id": 203,
        "item_type": "task",
        "item_name": "#1: Ticket title",
        "item_deleted_at": null,
        "parent_id": 693,
        "parent_type": "project",
        "parent_name": "test project",
        "parent_deleted_at": null,
        "root_id": 693,
        "root_type": "project",
        "root_name": "test project",
        "root_deleted_at": null,
        "deal_is_budget": false,
        "task_id": 203,
        "deal_id": null,
        "invoice_id": null,
        "company_id": null,
        "person_id": null,
        "created_at": "2020-01-16T14:40:04.472+01:00"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1170
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2790"
          }
        },
        "comment": {
          "data": null
        },
        "email": {
          "data": null
        },
        "attachment": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "2790",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:04.000+01:00",
        "last_seen_at": "2020-01-16T14:40:04.598+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:02.980+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1170
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3882"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3882",
      "type": "companies",
      "attributes": {
        "name": "Organization1",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:02.976+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1170
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/activities?filter%5Btask_id%5D=203&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get activities
GET/api/v2/activities


GET /api/v2/activities/1
Requestsreturns activity

GET  /api/v2/activities/18

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "18",
    "type": "activities",
    "attributes": {
      "event": "create",
      "changes": "",
      "changeset": [],
      "item_id": 208,
      "item_type": "task",
      "item_name": "#1: Ticket title",
      "item_deleted_at": null,
      "parent_id": 708,
      "parent_type": "project",
      "parent_name": "test project",
      "parent_deleted_at": null,
      "root_id": 708,
      "root_type": "project",
      "root_name": "test project",
      "root_deleted_at": null,
      "deal_is_budget": false,
      "task_id": 208,
      "deal_id": null,
      "invoice_id": null,
      "company_id": null,
      "person_id": null,
      "created_at": "2020-01-16T14:40:08.414+01:00"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1173
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2820"
        }
      },
      "comment": {
        "data": null
      },
      "email": {
        "data": null
      },
      "attachment": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2820",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user31@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:08.000+01:00",
        "last_seen_at": "2020-01-16T14:40:08.431+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:07.952+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1173
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3927"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3927",
      "type": "companies",
      "attributes": {
        "name": "Organization4",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:07.951+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1173
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a activity
GET/api/v2/activities/{id}

URI Parameters
HideShow
id
number (required) Example: 1

activity id


Attachments

Attachments

Supported filter params

  • comment_id

  • page_id

  • task_id

GET /api/v2/attachments
Requestsreturns attachments

GET  /api/v2/attachments?filter[comment_id]=59

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "37",
      "type": "attachments",
      "attributes": {
        "name": "img.png",
        "type": "image/png",
        "content_type": "image/png",
        "size": 3479,
        "url": "/system/attachments/files/000/000/037/original/img.png?1579182008",
        "thumb": "/system/attachments/files/000/000/037/thumb/img.png?1579182008",
        "temp_url": null,
        "processed": false,
        "resized": false,
        "created_at": "2020-01-16T14:40:08.701+01:00",
        "deleted_at": null,
        "attachable_type": "comment",
        "aws_policy": {
          "key": "attachments/files/000/000/037/original/img.png",
          "AWSAccessKeyId": "AKIAJXZVZPAUM5RRVDGA",
          "acl": "public-read",
          "success_action_status": "201",
          "policy": "eyJleHBpcmF0aW9uIjoiMjAyMC0wMS0xNlQyMzo0MDowOFoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJwcm9kdWN0aXZlLWZpbGVzLWRldmVsb3BtZW50In0seyJhY2wiOiJwdWJsaWMtcmVhZCJ9LHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJhdHRhY2htZW50cy8iXSxbInN0YXJ0cy13aXRoIiwiJENvbnRlbnQtVHlwZSIsIiJdXX0=",
          "signature": "ZjzZvvUiyHr+ckpGtDmcEL5b/Hg=",
          "Content-Type": "image/png"
        }
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1174
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2826"
          }
        },
        "invoice": {
          "data": null
        },
        "email": {
          "data": null
        },
        "page": {
          "data": null
        },
        "expense": {
          "data": null
        },
        "comment": {
          "data": {
            "type": "comments",
            "id": "59"
          }
        },
        "task": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "2826",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user37@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:08.000+01:00",
        "last_seen_at": "2020-01-16T14:40:08.735+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:08.572+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1174
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3936"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "59",
      "type": "comments",
      "attributes": {
        "commentable_type": "company",
        "body": "test body",
        "created_at": "2020-01-16T14:40:08.597+01:00",
        "pinned_at": null,
        "edited_at": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1174
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2826"
          }
        },
        "pinned_by": {
          "data": null
        },
        "person": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3937"
          }
        },
        "deal": {
          "data": null
        },
        "task": {
          "data": null
        },
        "invoice": {
          "data": null
        },
        "attachments": {
          "data": [
            {
              "type": "attachments",
              "id": "37"
            }
          ]
        }
      }
    },
    {
      "id": "3936",
      "type": "companies",
      "attributes": {
        "name": "Organization5",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:08.570+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1174
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3937",
      "type": "companies",
      "attributes": {
        "name": "Client51",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:08.593+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1174
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/attachments?filter%5Bcomment_id%5D=59&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/attachments?filter%5Bcomment_id%5D=59&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get attachments
GET/api/v2/attachments


GET /api/v2/attachments/1
Requestsreturns attachment

GET  /api/v2/attachments/38

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "38",
    "type": "attachments",
    "attributes": {
      "name": "img.png",
      "type": "image/png",
      "content_type": "image/png",
      "size": 3479,
      "url": "/system/attachments/files/000/000/038/original/img.png?1579182009",
      "thumb": "/system/attachments/files/000/000/038/thumb/img.png?1579182009",
      "temp_url": null,
      "processed": false,
      "resized": false,
      "created_at": "2020-01-16T14:40:09.106+01:00",
      "deleted_at": null,
      "attachable_type": "comment",
      "aws_policy": {
        "key": "attachments/files/000/000/038/original/img.png",
        "AWSAccessKeyId": "AKIAJXZVZPAUM5RRVDGA",
        "acl": "public-read",
        "success_action_status": "201",
        "policy": "eyJleHBpcmF0aW9uIjoiMjAyMC0wMS0xNlQyMzo0MDowOVoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJwcm9kdWN0aXZlLWZpbGVzLWRldmVsb3BtZW50In0seyJhY2wiOiJwdWJsaWMtcmVhZCJ9LHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJhdHRhY2htZW50cy8iXSxbInN0YXJ0cy13aXRoIiwiJENvbnRlbnQtVHlwZSIsIiJdXX0=",
        "signature": "/3cp6fezzvC04Rf1tc5qU9QF+is=",
        "Content-Type": "image/png"
      }
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1175
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2827"
        }
      },
      "invoice": {
        "data": null
      },
      "email": {
        "data": null
      },
      "page": {
        "data": null
      },
      "expense": {
        "data": null
      },
      "comment": {
        "data": {
          "type": "comments",
          "id": "60"
        }
      },
      "task": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2827",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user38@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:09.000+01:00",
        "last_seen_at": "2020-01-16T14:40:09.154+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:09.027+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1175
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3938"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "60",
      "type": "comments",
      "attributes": {
        "commentable_type": "company",
        "body": "test body",
        "created_at": "2020-01-16T14:40:09.058+01:00",
        "pinned_at": null,
        "edited_at": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1175
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2827"
          }
        },
        "pinned_by": {
          "data": null
        },
        "person": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3939"
          }
        },
        "deal": {
          "data": null
        },
        "task": {
          "data": null
        },
        "invoice": {
          "data": null
        },
        "attachments": {
          "data": [
            {
              "type": "attachments",
              "id": "38"
            }
          ]
        }
      }
    },
    {
      "id": "3938",
      "type": "companies",
      "attributes": {
        "name": "Organization6",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:09.025+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1175
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3939",
      "type": "companies",
      "attributes": {
        "name": "Client52",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:09.054+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1175
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a attachment
GET/api/v2/attachments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

attachment id


POST /api/v2/attachments
Requestscreates attachmentreturns error

POST  /api/v2/attachments

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "attachments",
    "attributes": {
      "name": "img.png",
      "attachable_id": 61,
      "attachable_type": "comment"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "40",
    "type": "attachments",
    "attributes": {
      "name": "img.png",
      "type": null,
      "content_type": null,
      "size": null,
      "url": "/system/attachments/files/000/000/040/original/img.png?1579182009",
      "thumb": null,
      "temp_url": null,
      "processed": true,
      "resized": false,
      "created_at": "2020-01-16T14:40:09.470+01:00",
      "deleted_at": null,
      "attachable_type": "comment",
      "aws_policy": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1176
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2828"
        }
      },
      "invoice": {
        "data": null
      },
      "email": {
        "data": null
      },
      "page": {
        "data": null
      },
      "expense": {
        "data": null
      },
      "comment": {
        "data": null
      },
      "task": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "included": [
    {
      "id": "2828",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user39@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:09.000+01:00",
        "last_seen_at": "2020-01-16T14:40:09.447+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:09.315+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1176
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3940"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "3940",
      "type": "companies",
      "attributes": {
        "name": "Organization7",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:09.313+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1176
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/attachments

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "attachments",
    "attributes": {
      "attachable_type": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/attachable_type"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "source": {
        "pointer": "data/attributes/attachable_type"
      }
    }
  ]
}

Create a attachment
POST/api/v2/attachments

URI Parameters
HideShow
name
string (required) Example: name

name

id
string (required) Example: Comment

attachable_type


PATCH /api/v2/attachments/1
Requestsupdates attachmentreturns error

PATCH  /api/v2/attachments/42

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "attachments",
    "attributes": {
      "temp_url": "https://s3.amazonaws.com/infinum.productive.test/uploads/1418301662608/dummyfile.pdf"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "42",
    "type": "attachments",
    "attributes": {
      "name": "img.png",
      "type": "image/png",
      "content_type": "image/png",
      "size": 3479,
      "url": "/system/attachments/files/000/000/042/original/img.png?1579182009",
      "thumb": "/system/attachments/files/000/000/042/thumb/img.png?1579182009",
      "temp_url": "https://s3.amazonaws.com/infinum.productive.test/uploads/1418301662608/dummyfile.pdf",
      "processed": false,
      "resized": false,
      "created_at": "2020-01-16T14:40:09.896+01:00",
      "deleted_at": null,
      "attachable_type": "comment",
      "aws_policy": {
        "key": "attachments/files/000/000/042/original/img.png",
        "AWSAccessKeyId": "AKIAJXZVZPAUM5RRVDGA",
        "acl": "public-read",
        "success_action_status": "201",
        "policy": "eyJleHBpcmF0aW9uIjoiMjAyMC0wMS0xNlQyMzo0MDoxMFoiLCJjb25kaXRpb25zIjpbeyJidWNrZXQiOiJwcm9kdWN0aXZlLWZpbGVzLWRldmVsb3BtZW50In0seyJhY2wiOiJwdWJsaWMtcmVhZCJ9LHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJhdHRhY2htZW50cy8iXSxbInN0YXJ0cy13aXRoIiwiJENvbnRlbnQtVHlwZSIsIiJdXX0=",
        "signature": "31EKGC+aoyNIkS0oAnV5mt+zPxk=",
        "Content-Type": "image/png"
      }
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1178
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2830"
        }
      },
      "invoice": {
        "data": null
      },
      "email": {
        "data": null
      },
      "page": {
        "data": null
      },
      "expense": {
        "data": null
      },
      "comment": {
        "data": {
          "type": "comments",
          "id": "63"
        }
      },
      "task": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "2830",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user41@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:09.000+01:00",
        "last_seen_at": "2020-01-16T14:40:09.934+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:09.814+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1178
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3944"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "63",
      "type": "comments",
      "attributes": {
        "commentable_type": "company",
        "body": "test body",
        "created_at": "2020-01-16T14:40:09.839+01:00",
        "pinned_at": null,
        "edited_at": null,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1178
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2830"
          }
        },
        "pinned_by": {
          "data": null
        },
        "person": {
          "data": null
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3945"
          }
        },
        "deal": {
          "data": null
        },
        "task": {
          "data": null
        },
        "invoice": {
          "data": null
        },
        "attachments": {
          "data": [
            {
              "type": "attachments",
              "id": "42"
            }
          ]
        }
      }
    },
    {
      "id": "3944",
      "type": "companies",
      "attributes": {
        "name": "Organization9",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:09.813+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1178
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "3945",
      "type": "companies",
      "attributes": {
        "name": "Client55",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:09.835+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1178
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/attachments/43

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "attachments",
    "attributes": {
      "attachable_type": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/attachable_type"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "source": {
        "pointer": "data/attributes/attachable_type"
      }
    }
  ]
}

Update a attachment
PATCH/api/v2/attachments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

attachment id


DELETE /api/v2/attachments/1
Requestsdeletes attachment

DELETE  /api/v2/attachments/44

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a attachment
DELETE/api/v2/attachments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

attachment id


Boards

Boards

Supported filter params

  • id

  • project_id

GET /api/v2/boards
Requestsreturns boards

GET  /api/v2/boards?filter[project_id]=723

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "233",
      "type": "boards",
      "attributes": {
        "name": "board name",
        "position": 1,
        "archived_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1222
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "723"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "723",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 1,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1222
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4026"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2893"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4026",
      "type": "companies",
      "attributes": {
        "name": "Client92",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:24.574+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1222
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2893",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user106@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:24.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:24.544+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1222
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4025"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4025",
      "type": "companies",
      "attributes": {
        "name": "Client91",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:24.537+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1222
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/boards?filter%5Bproject_id%5D=723&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/boards?filter%5Bproject_id%5D=723&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get boards
GET/api/v2/boards


GET /api/v2/boards/1
Requestsreturns board

GET  /api/v2/boards/234

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "234",
    "type": "boards",
    "attributes": {
      "name": "board name",
      "position": 1,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1223
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "724"
        }
      }
    }
  },
  "included": [
    {
      "id": "724",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 1,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1223
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4029"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2895"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4029",
      "type": "companies",
      "attributes": {
        "name": "Client94",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:25.109+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1223
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2895",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user108@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:25.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:25.059+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1223
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4028"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4028",
      "type": "companies",
      "attributes": {
        "name": "Client93",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:25.053+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1223
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a board
GET/api/v2/boards/{id}

URI Parameters
HideShow
id
number (required) Example: 1

board id


POST /api/v2/boards
Requestscreates boardreturns error

POST  /api/v2/boards

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "name": "test name"
    },
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "725"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "236",
    "type": "boards",
    "attributes": {
      "name": "test name",
      "position": 2,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1224
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "725"
        }
      }
    }
  },
  "included": [
    {
      "id": "725",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 2,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1224
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4032"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2897"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4032",
      "type": "companies",
      "attributes": {
        "name": "Client96",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:25.705+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1224
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2897",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user110@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:25.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:25.675+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1224
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4031"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4031",
      "type": "companies",
      "attributes": {
        "name": "Client95",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:25.669+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1224
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/boards

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Create a board
POST/api/v2/boards

URI Parameters
HideShow
name
string (required) Example: Name

name


PATCH /api/v2/boards/1
Requestsupdates boardreturns error

PATCH  /api/v2/boards/239

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "239",
    "type": "boards",
    "attributes": {
      "name": "new name",
      "position": 1,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1227
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "728"
        }
      }
    }
  },
  "included": [
    {
      "id": "728",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 1,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1227
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4041"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2903"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4041",
      "type": "companies",
      "attributes": {
        "name": "Client102",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:26.983+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1227
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2903",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user116@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:26.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:26.949+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1227
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4040"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4040",
      "type": "companies",
      "attributes": {
        "name": "Client101",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:26.940+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1227
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/boards/240

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "boards",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Update a board
PATCH/api/v2/boards/{id}

URI Parameters
HideShow
id
number (required) Example: 1

board id


PATCH /api/v2/boards/1/archive
Requestsarchives board

PATCH  /api/v2/boards/242/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "242",
    "type": "boards",
    "attributes": {
      "name": "board name",
      "position": null,
      "archived_at": "2020-01-16T14:40:28.000+01:00"
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1230
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "731"
        }
      }
    }
  },
  "included": [
    {
      "id": "731",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1230
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4050"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2909"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4050",
      "type": "companies",
      "attributes": {
        "name": "Client108",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:28.217+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1230
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2909",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user122@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:28.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:28.174+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1230
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4049"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4049",
      "type": "companies",
      "attributes": {
        "name": "Client107",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:28.169+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1230
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Archives a board
PATCH/api/v2/boards/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

board id


PATCH /api/v2/boards/1/restore
Requestsrestores board

PATCH  /api/v2/boards/243/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "243",
    "type": "boards",
    "attributes": {
      "name": "Board11",
      "position": 2,
      "archived_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1231
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "732"
        }
      }
    }
  },
  "included": [
    {
      "id": "732",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 1,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1231
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4053"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2911"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4053",
      "type": "companies",
      "attributes": {
        "name": "Client110",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:28.711+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1231
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2911",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user124@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:28.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:28.679+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1231
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4052"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4052",
      "type": "companies",
      "attributes": {
        "name": "Client109",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:28.672+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1231
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Restores a board
PATCH/api/v2/boards/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

board id


Bookings

Bookings

Supported filter params

  • person_id

  • event_id

  • project_id

  • budget_id

  • origin_id

  • tags

  • after

  • before

GET /api/v2/bookings
Requestsreturns bookings

GET  /api/v2/bookings

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "21",
      "type": "bookings",
      "attributes": {
        "hours": 6,
        "time": 360,
        "started_on": "2020-01-16",
        "ended_on": "2020-01-16",
        "note": null,
        "total_hours": 0,
        "total_time": 0,
        "created_at": "2020-01-16T14:40:29.487+01:00",
        "updated_at": "2020-01-16T14:40:29.487+01:00",
        "people_custom_fields": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1232
          }
        },
        "service": {
          "data": null
        },
        "event": {
          "data": {
            "type": "events",
            "id": "35"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "origin": {
          "data": null
        }
      }
    },
    {
      "id": "22",
      "type": "bookings",
      "attributes": {
        "hours": 6,
        "time": 360,
        "started_on": "2020-01-16",
        "ended_on": "2020-01-16",
        "note": null,
        "total_hours": 0,
        "total_time": 0,
        "created_at": "2020-01-16T14:40:29.623+01:00",
        "updated_at": "2020-01-16T14:40:29.623+01:00",
        "people_custom_fields": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1232
          }
        },
        "service": {
          "data": null
        },
        "event": {
          "data": {
            "type": "events",
            "id": "35"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "origin": {
          "data": null
        }
      }
    },
    {
      "id": "23",
      "type": "bookings",
      "attributes": {
        "hours": 6,
        "time": 360,
        "started_on": "2020-01-16",
        "ended_on": "2020-01-16",
        "note": null,
        "total_hours": 0,
        "total_time": 0,
        "created_at": "2020-01-16T14:40:29.644+01:00",
        "updated_at": "2020-01-16T14:40:29.644+01:00",
        "people_custom_fields": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1232
          }
        },
        "service": {
          "data": null
        },
        "event": {
          "data": {
            "type": "events",
            "id": "35"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "2912"
          }
        },
        "origin": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "35",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1232
          }
        }
      }
    },
    {
      "id": "2912",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user125@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:29.000+01:00",
        "last_seen_at": "2020-01-16T14:40:29.708+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:29.171+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1232
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4054"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4054",
      "type": "companies",
      "attributes": {
        "name": "Organization63",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:29.166+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1232
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/bookings?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/bookings?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get bookings
GET/api/v2/bookings


GET /api/v2/bookings/1
Requestsreturns booking

GET  /api/v2/bookings/24

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "24",
    "type": "bookings",
    "attributes": {
      "hours": 6,
      "time": 360,
      "started_on": "2020-01-16",
      "ended_on": "2020-01-16",
      "note": null,
      "total_hours": 0,
      "total_time": 0,
      "created_at": "2020-01-16T14:40:30.181+01:00",
      "updated_at": "2020-01-16T14:40:30.181+01:00",
      "people_custom_fields": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1233
        }
      },
      "service": {
        "data": null
      },
      "event": {
        "data": {
          "type": "events",
          "id": "36"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "2913"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2913"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "2913"
        }
      },
      "origin": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "36",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1233
          }
        }
      }
    },
    {
      "id": "2913",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user126@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:30.000+01:00",
        "last_seen_at": "2020-01-16T14:40:30.208+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:30.148+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1233
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4055"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4055",
      "type": "companies",
      "attributes": {
        "name": "Organization64",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:30.146+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1233
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a booking
GET/api/v2/bookings/{id}

URI Parameters
HideShow
id
number (required) Example: 1

booking id


POST /api/v2/bookings
Requestscreates the bookingreturns error

POST  /api/v2/bookings

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "bookings",
    "attributes": {
      "started_on": "Jan 16, 2020",
      "ended_on": "Jan 16, 2020",
      "time": 360
    },
    "relationships": {
      "event": {
        "data": {
          "type": "events",
          "id": "37"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "2914"
        }
      },
      "origin": {
        "data": {
          "type": "bookings",
          "id": "25"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "26",
    "type": "bookings",
    "attributes": {
      "hours": 6,
      "time": 360,
      "started_on": "2020-01-16",
      "ended_on": "2020-01-16",
      "note": null,
      "total_hours": 0,
      "total_time": 0,
      "created_at": "2020-01-16T14:40:30.467+01:00",
      "updated_at": "2020-01-16T14:40:30.467+01:00",
      "people_custom_fields": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1234
        }
      },
      "service": {
        "data": null
      },
      "event": {
        "data": {
          "type": "events",
          "id": "37"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "2914"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2914"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "2914"
        }
      },
      "origin": {
        "data": {
          "type": "bookings",
          "id": "25"
        }
      }
    }
  },
  "included": [
    {
      "id": "37",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1234
          }
        }
      }
    },
    {
      "id": "2914",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user127@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:30.000+01:00",
        "last_seen_at": "2020-01-16T14:40:30.442+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:30.376+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1234
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4056"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "25",
      "type": "bookings",
      "attributes": {
        "hours": 6,
        "time": 360,
        "started_on": "2020-01-16",
        "ended_on": "2020-01-16",
        "note": null,
        "total_hours": 0,
        "total_time": 0,
        "created_at": "2020-01-16T14:40:30.416+01:00",
        "updated_at": "2020-01-16T14:40:30.416+01:00",
        "people_custom_fields": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1234
          }
        },
        "service": {
          "data": null
        },
        "event": {
          "data": {
            "type": "events",
            "id": "37"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "2914"
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2914"
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "2914"
          }
        },
        "origin": {
          "data": null
        }
      }
    },
    {
      "id": "4056",
      "type": "companies",
      "attributes": {
        "name": "Organization65",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:30.374+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1234
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/bookings

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "bookings",
    "attributes": {
      "time": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/person"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/started_on"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/started_on"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/ended_on"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not a date",
      "source": {
        "pointer": "data/attributes/ended_on"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/time"
      }
    }
  ]
}

Create a booking
POST/api/v2/bookings

URI Parameters
HideShow
person_id
number (required) Example: 1

person id

started_on
date (required) Example: 2018-01-01

started on

ended_on
date (required) Example: 2018-01-31

ended on

time
number (required) Example: 60

time


PATCH /api/v2/bookings/1
Requestsupdates bookingreturnes error

PATCH  /api/v2/bookings/28

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "bookings",
    "attributes": {
      "time": 120
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "28",
    "type": "bookings",
    "attributes": {
      "hours": 2,
      "time": 120,
      "started_on": "2020-01-16",
      "ended_on": "2020-01-16",
      "note": null,
      "total_hours": 0,
      "total_time": 0,
      "created_at": "2020-01-16T14:40:30.804+01:00",
      "updated_at": "2020-01-16T14:40:30.852+01:00",
      "people_custom_fields": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1236
        }
      },
      "service": {
        "data": null
      },
      "event": {
        "data": {
          "type": "events",
          "id": "39"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "2916"
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2916"
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "2916"
        }
      },
      "origin": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "39",
      "type": "events",
      "attributes": {
        "name": "test name",
        "event_type_id": 2,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1236
          }
        }
      }
    },
    {
      "id": "2916",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user129@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:30.000+01:00",
        "last_seen_at": "2020-01-16T14:40:30.833+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:30.773+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1236
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4058"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4058",
      "type": "companies",
      "attributes": {
        "name": "Organization67",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:30.771+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1236
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/bookings/29

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "bookings",
    "attributes": {
      "time": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/time"
      }
    }
  ]
}

Update a booking
PATCH/api/v2/bookings/{id}

URI Parameters
HideShow
id
number (required) Example: 1

booking id


DELETE /api/v2/bookings/1
Requestsdeletes booking

DELETE  /api/v2/bookings/30

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a booking
DELETE/api/v2/bookings/{id}

URI Parameters
HideShow
id
number (required) Example: 1

booking id


Comments

Comments

GET /api/v2/comments/1
Requestsreturns comment

GET  /api/v2/comments/66

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "66",
    "type": "comments",
    "attributes": {
      "commentable_type": "company",
      "body": "blah",
      "created_at": "2020-01-16T14:40:31.348+01:00",
      "pinned_at": null,
      "edited_at": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1239
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2919"
        }
      },
      "pinned_by": {
        "data": null
      },
      "person": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4062"
        }
      },
      "deal": {
        "data": null
      },
      "task": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "attachments": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "2919",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user132@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:31.000+01:00",
        "last_seen_at": "2020-01-16T14:40:31.369+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:31.321+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1239
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4061"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4062",
      "type": "companies",
      "attributes": {
        "name": "Client111",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:31.344+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1239
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4061",
      "type": "companies",
      "attributes": {
        "name": "Organization70",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:31.319+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1239
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a comment
GET/api/v2/comments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

comment id


POST /api/v2/comments
Requestscreates staged commentreturns error

POST  /api/v2/comments

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "comments",
    "attributes": {
      "commentable_type": "task"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "68",
    "type": "comments",
    "attributes": {
      "commentable_type": "task",
      "body": null,
      "created_at": "2020-01-16T14:40:31.663+01:00",
      "pinned_at": null,
      "edited_at": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1240
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2920"
        }
      },
      "pinned_by": {
        "data": null
      },
      "person": {
        "data": null
      },
      "company": {
        "data": null
      },
      "deal": {
        "data": null
      },
      "task": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "attachments": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "2920",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user133@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:31.000+01:00",
        "last_seen_at": "2020-01-16T14:40:31.652+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:31.604+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1240
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4063"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4063",
      "type": "companies",
      "attributes": {
        "name": "Organization71",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:31.602+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1240
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/comments

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "comments",
    "attributes": {
      "commentable_type": "invalid"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "source": {
        "pointer": "data/attributes/commentable_type"
      }
    }
  ]
}

Create a comment
POST/api/v2/comments


PATCH /api/v2/comments/1
Requestsupdates comment

PATCH  /api/v2/comments/70

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "comments",
    "attributes": {
      "body": "new body"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "70",
    "type": "comments",
    "attributes": {
      "commentable_type": "company",
      "body": "new body",
      "created_at": "2020-01-16T14:40:31.948+01:00",
      "pinned_at": null,
      "edited_at": "2020-01-16T14:40:31.988+01:00",
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1242
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2922"
        }
      },
      "pinned_by": {
        "data": null
      },
      "person": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4068"
        }
      },
      "deal": {
        "data": null
      },
      "task": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "attachments": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "2922",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user135@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:31.000+01:00",
        "last_seen_at": "2020-01-16T14:40:31.968+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:31.919+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1242
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4067"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4068",
      "type": "companies",
      "attributes": {
        "name": "Client114",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:31.944+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1242
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4067",
      "type": "companies",
      "attributes": {
        "name": "Organization73",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:31.917+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1242
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Update a comment
PATCH/api/v2/comments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

comment id


PATCH /api/v2/comments/1/pin
Requestspins the commentdoes not pin the comment

PATCH  /api/v2/comments/72/pin

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "72",
    "type": "comments",
    "attributes": {
      "commentable_type": "company",
      "body": "blah",
      "created_at": "2020-01-16T14:40:32.401+01:00",
      "pinned_at": "2020-01-16T14:40:32.000+01:00",
      "edited_at": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1244
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2924"
        }
      },
      "pinned_by": {
        "data": null
      },
      "person": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4072"
        }
      },
      "deal": {
        "data": null
      },
      "task": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "attachments": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "2924",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user137@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:32.000+01:00",
        "last_seen_at": "2020-01-16T14:40:32.418+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:32.373+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1244
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4071"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4072",
      "type": "companies",
      "attributes": {
        "name": "Client116",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:32.397+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1244
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4071",
      "type": "companies",
      "attributes": {
        "name": "Organization75",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:32.370+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1244
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/comments/73/pin

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {
        "pointer": null
      }
    }
  ]
}

Pins a comment
PATCH/api/v2/comments/{id}/pin

URI Parameters
HideShow
id
number (required) Example: 1

comment id


PATCH /api/v2/comments/1/unpin
Requestsunpins the commentdoes not unpin the comment

PATCH  /api/v2/comments/74/unpin

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "74",
    "type": "comments",
    "attributes": {
      "commentable_type": "company",
      "body": "blah",
      "created_at": "2020-01-16T14:40:32.925+01:00",
      "pinned_at": null,
      "edited_at": null,
      "deleted_at": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1246
        }
      },
      "creator": {
        "data": {
          "type": "people",
          "id": "2926"
        }
      },
      "pinned_by": {
        "data": null
      },
      "person": {
        "data": null
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4076"
        }
      },
      "deal": {
        "data": null
      },
      "task": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "attachments": {
        "data": []
      }
    }
  },
  "included": [
    {
      "id": "2926",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user139@email.com",
        "title": null,
        "joined_at": "2020-01-16T14:40:32.000+01:00",
        "last_seen_at": "2020-01-16T14:40:32.965+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:32.877+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1246
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4075"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4076",
      "type": "companies",
      "attributes": {
        "name": "Client118",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:32.917+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1246
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4075",
      "type": "companies",
      "attributes": {
        "name": "Organization77",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:32.876+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1246
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/comments/75/unpin

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {
        "pointer": null
      }
    }
  ]
}

Unpins a comment
PATCH/api/v2/comments/{id}/unpin

URI Parameters
HideShow
id
number (required) Example: 1

comment id


DELETE /api/v2/comments/1
Requestsarchives comment

DELETE  /api/v2/comments/76

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a comment
DELETE/api/v2/comments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

comment id


Companies

Companies

Supported filter params

  • id

  • status (1: active, 2: archived)

  • tags

  • query

GET /api/v2/companies
Requestsreturns companies

GET  /api/v2/companies

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "4082",
      "type": "companies",
      "attributes": {
        "name": "Client121",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:33.535+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1249
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4081",
      "type": "companies",
      "attributes": {
        "name": "Organization80",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:33.511+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1249
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/companies?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/companies?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 2,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get companies
GET/api/v2/companies


GET /api/v2/companies/1
Requestsreturns company

GET  /api/v2/companies/4084

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4084",
    "type": "companies",
    "attributes": {
      "name": "Client122",
      "default_currency": null,
      "created_at": "2020-01-16T14:40:33.679+01:00",
      "archived_at": null,
      "avatar_url": null,
      "invoice_email_recipients": {},
      "custom_fields": null,
      "description": null,
      "due_days": null,
      "tag_list": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1250
        }
      },
      "bill_to": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a company
GET/api/v2/companies/{id}

URI Parameters
HideShow
id
number (required) Example: 1

company id


POST /api/v2/companies
Requestscreates companyreturns error

POST  /api/v2/companies

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "companies",
    "attributes": {
      "name": "test name"
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4087",
    "type": "companies",
    "attributes": {
      "name": "test name",
      "default_currency": null,
      "created_at": "2020-01-16T14:40:33.872+01:00",
      "archived_at": null,
      "avatar_url": null,
      "invoice_email_recipients": {},
      "custom_fields": null,
      "description": null,
      "due_days": null,
      "tag_list": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1251
        }
      },
      "bill_to": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/companies

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "companies",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Create a company
POST/api/v2/companies

URI Parameters
HideShow
name
string (required) Example: Name

name


PATCH /api/v2/companies/1
Requestsupdates companyreturns error

PATCH  /api/v2/companies/4091

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "companies",
    "attributes": {
      "name": "new name",
      "tag_list": [
        "design",
        "IT"
      ]
    },
    "relationships": {
      "subscribers": {
        "data": [
          {
            "type": "people",
            "id": "2934"
          },
          {
            "type": "people",
            "id": "2935"
          }
        ]
      }
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4091",
    "type": "companies",
    "attributes": {
      "name": "new name",
      "default_currency": null,
      "created_at": "2020-01-16T14:40:34.126+01:00",
      "archived_at": null,
      "avatar_url": null,
      "invoice_email_recipients": {},
      "custom_fields": null,
      "description": null,
      "due_days": null,
      "tag_list": [
        "design",
        "IT"
      ]
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1253
        }
      },
      "bill_to": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/companies/4095

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "companies",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Update a company
PATCH/api/v2/companies/{id}

URI Parameters
HideShow
id
number (required) Example: 1

company id


PATCH /api/v2/companies/1/archive
Requestsarchives companyreturns error

PATCH  /api/v2/companies/4097/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4097",
    "type": "companies",
    "attributes": {
      "name": "Client129",
      "default_currency": null,
      "created_at": "2020-01-16T14:40:34.740+01:00",
      "archived_at": "2020-01-16T14:40:34.000+01:00",
      "avatar_url": null,
      "invoice_email_recipients": {},
      "custom_fields": null,
      "description": null,
      "due_days": null,
      "tag_list": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1255
        }
      },
      "bill_to": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/companies/4099/archive

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {
        "pointer": null
      }
    }
  ]
}

Archives a company
PATCH/api/v2/companies/{id}/archive

URI Parameters
HideShow
id
number (required) Example: 1

company id


PATCH /api/v2/companies/1/restore
Requestsreturns errorrestores company

PATCH  /api/v2/companies/4101/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses403
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "403",
      "title": "Access Denied",
      "detail": "You are not authorized to access this resource",
      "source": {
        "pointer": null
      }
    }
  ]
}

PATCH  /api/v2/companies/4103/restore

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "4103",
    "type": "companies",
    "attributes": {
      "name": "Client132",
      "default_currency": null,
      "created_at": "2020-01-16T14:40:35.290+01:00",
      "archived_at": null,
      "avatar_url": null,
      "invoice_email_recipients": {},
      "custom_fields": null,
      "description": null,
      "due_days": null,
      "tag_list": []
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1258
        }
      },
      "bill_to": {
        "data": null
      }
    }
  },
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Restores a company
PATCH/api/v2/companies/{id}/restore

URI Parameters
HideShow
id
number (required) Example: 1

company id


Contact Entries

Contact Entries

Supported filter params

  • person_id

  • company_id

  • invoice_id

GET /api/v2/contact_entries
Requestsreturns contact entries

GET  /api/v2/contact_entries

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "109",
      "type": "contact_entries",
      "attributes": {
        "contactable_type": "company",
        "type": "email",
        "name": "Personal",
        "email": "contact1@email.com",
        "phone": null,
        "website": null,
        "address": null,
        "city": null,
        "state": null,
        "zipcode": null,
        "country": null,
        "vat": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1259
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4105"
          }
        },
        "person": {
          "data": null
        },
        "invoice": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "110",
      "type": "contact_entries",
      "attributes": {
        "contactable_type": "company",
        "type": "email",
        "name": "Personal",
        "email": "contact2@email.com",
        "phone": null,
        "website": null,
        "address": null,
        "city": null,
        "state": null,
        "zipcode": null,
        "country": null,
        "vat": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1259
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4105"
          }
        },
        "person": {
          "data": null
        },
        "invoice": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "111",
      "type": "contact_entries",
      "attributes": {
        "contactable_type": "company",
        "type": "email",
        "name": "Personal",
        "email": "contact3@email.com",
        "phone": null,
        "website": null,
        "address": null,
        "city": null,
        "state": null,
        "zipcode": null,
        "country": null,
        "vat": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1259
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4105"
          }
        },
        "person": {
          "data": null
        },
        "invoice": {
          "data": null
        },
        "subsidiary": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "4105",
      "type": "companies",
      "attributes": {
        "name": "Client133",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:35.529+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1259
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/contact_entries?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/contact_entries?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get contact entries
GET/api/v2/contact_entries


GET /api/v2/contact_entries/1
Requestsreturns contact_entry

GET  /api/v2/contact_entries/112

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "112",
    "type": "contact_entries",
    "attributes": {
      "contactable_type": "company",
      "type": "email",
      "name": "Personal",
      "email": "contact4@email.com",
      "phone": null,
      "website": null,
      "address": null,
      "city": null,
      "state": null,
      "zipcode": null,
      "country": null,
      "vat": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1260
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4107"
        }
      },
      "person": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "4107",
      "type": "companies",
      "attributes": {
        "name": "Client134",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:35.779+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1260
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a contact entry
GET/api/v2/contact_entries/{id}

URI Parameters
HideShow
id
number (required) Example: 1

contact entry id


POST /api/v2/contact_entries
Requestscreates contact_entryreturns error

POST  /api/v2/contact_entries

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contact_entries",
    "attributes": {
      "contactable_type": "company",
      "type": "email",
      "name": "Work",
      "email": "contact@email.com"
    },
    "relationships": {
      "company": {
        "data": {
          "type": "companies",
          "id": "4109"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "114",
    "type": "contact_entries",
    "attributes": {
      "contactable_type": "company",
      "type": "email",
      "name": "Work",
      "email": "contact@email.com",
      "phone": null,
      "website": null,
      "address": null,
      "city": null,
      "state": null,
      "zipcode": null,
      "country": null,
      "vat": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1261
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4109"
        }
      },
      "person": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "4109",
      "type": "companies",
      "attributes": {
        "name": "Client135",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:36.028+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1261
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/contact_entries

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contact_entries",
    "attributes": {
      "type": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/type"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "source": {
        "pointer": "data/attributes/type"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/contactable_type"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not included in the list",
      "source": {
        "pointer": "data/attributes/contactable_type"
      }
    }
  ]
}

Create a contact entry
POST/api/v2/contact_entries

URI Parameters
HideShow
name
string (required) Example: Name

name

type
string (required) Example: Address

type

contactable_type
string (required) Example: Client

contactable type


PATCH /api/v2/contact_entries/1
Requestsupdates contact_entryreturns error

PATCH  /api/v2/contact_entries/123

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contact_entries",
    "attributes": {
      "name": "new name"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "123",
    "type": "contact_entries",
    "attributes": {
      "contactable_type": "company",
      "type": "email",
      "name": "new name",
      "email": "contact11@email.com",
      "phone": null,
      "website": null,
      "address": null,
      "city": null,
      "state": null,
      "zipcode": null,
      "country": null,
      "vat": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1267
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "4120"
        }
      },
      "person": {
        "data": null
      },
      "invoice": {
        "data": null
      },
      "subsidiary": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "4120",
      "type": "companies",
      "attributes": {
        "name": "Client140",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:38.178+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1267
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/contact_entries/124

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contact_entries",
    "attributes": {
      "name": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/name"
      }
    }
  ]
}

Update a contact entry
PATCH/api/v2/contact_entries/{id}

URI Parameters
HideShow
id
number (required) Example: 1

contact entry id


DELETE /api/v2/contact_entries/1
Requestsdeletes contact_entry

DELETE  /api/v2/contact_entries/126

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a contact entry
DELETE/api/v2/contact_entries/{id}

URI Parameters
HideShow
id
number (required) Example: 1

contact entry id


Contracts

Contracts

GET /api/v2/contracts
Requestsreturns contracts

GET  /api/v2/contracts

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "29",
      "type": "contracts",
      "attributes": {
        "ends_on": null,
        "next_occurrence_on": "2017-02-01",
        "interval_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "template": {
          "data": {
            "type": "deals",
            "id": "303"
          }
        }
      }
    },
    {
      "id": "30",
      "type": "contracts",
      "attributes": {
        "ends_on": null,
        "next_occurrence_on": "2017-02-01",
        "interval_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 693
          }
        },
        "template": {
          "data": {
            "type": "deals",
            "id": "513"
          }
        }
      }
    },
    {
      "id": "31",
      "type": "contracts",
      "attributes": {
        "ends_on": null,
        "next_occurrence_on": "2017-02-01",
        "interval_id": 1
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 693
          }
        },
        "template": {
          "data": {
            "type": "deals",
            "id": "514"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "303",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-01-16",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "469d4b34f9ba39129e07b319a80bd981",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-01-16T14:40:39.342+01:00",
        "note": null,
        "sales_closed_at": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_reimbursable": 0,
        "expense_reimbursable_default": 0,
        "expense_reimbursable_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2955"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4130"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2956"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6489"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        }
      }
    },
    {
      "id": "304",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2017-01-01",
        "end_date": null,
        "number": 2,
        "suffix": null,
        "time_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "e441728fe412ddd898770232e721094a",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "note": null,
        "sales_closed_at": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_reimbursable": 0,
        "expense_reimbursable_default": 0,
        "expense_reimbursable_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2955"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4132"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2957"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6490"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        }
      }
    },
    {
      "id": "305",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2017-01-01",
        "end_date": null,
        "number": 3,
        "suffix": null,
        "time_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "9521212ecbd7ae04700adff8f661b055",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "note": null,
        "sales_closed_at": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_reimbursable": 0,
        "expense_reimbursable_default": 0,
        "expense_reimbursable_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2955"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4134"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2958"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6491"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        }
      }
    },
    {
      "id": "2955",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user168@email.com",
        "title": null,
        "joined_at": "2017-01-01T15:00:00.000+01:00",
        "last_seen_at": "2017-01-01T15:00:00.000+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:39.127+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4129"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4130",
      "type": "companies",
      "attributes": {
        "name": "Client145",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:39.226+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2956",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user169@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:39.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:39.244+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4131"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6489",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        }
      }
    },
    {
      "id": "4132",
      "type": "companies",
      "attributes": {
        "name": "Client147",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2957",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user170@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2017-01-01T15:00:00.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4133"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6490",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 7,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        }
      }
    },
    {
      "id": "4134",
      "type": "companies",
      "attributes": {
        "name": "Client149",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2958",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user171@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2017-01-01T15:00:00.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4135"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6491",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 8,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        }
      }
    },
    {
      "id": "4129",
      "type": "companies",
      "attributes": {
        "name": "Organization103",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:39.126+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4131",
      "type": "companies",
      "attributes": {
        "name": "Client146",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:39.239+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4133",
      "type": "companies",
      "attributes": {
        "name": "Client148",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4135",
      "type": "companies",
      "attributes": {
        "name": "Client150",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1272
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/contracts?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/contracts?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 3,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get contracts
GET/api/v2/contracts


GET /api/v2/contracts/1
Requestsreturns contract

GET  /api/v2/contracts/32

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "32",
    "type": "contracts",
    "attributes": {
      "ends_on": null,
      "next_occurrence_on": "2017-02-01",
      "interval_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1273
        }
      },
      "template": {
        "data": {
          "type": "deals",
          "id": "306"
        }
      }
    }
  },
  "included": [
    {
      "id": "306",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-01-16",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "1ade132173ee650769d5b44f1cc7a451",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-01-16T14:40:40.260+01:00",
        "note": null,
        "sales_closed_at": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_reimbursable": 0,
        "expense_reimbursable_default": 0,
        "expense_reimbursable_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1273
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2959"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4137"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2960"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6497"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        }
      }
    },
    {
      "id": "2959",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user172@email.com",
        "title": null,
        "joined_at": "2017-01-01T15:00:00.000+01:00",
        "last_seen_at": "2017-01-01T15:00:00.000+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:40.167+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1273
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4136"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4137",
      "type": "companies",
      "attributes": {
        "name": "Client151",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:40.201+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1273
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2960",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user173@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:40.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:40.220+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1273
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4138"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6497",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1273
          }
        }
      }
    },
    {
      "id": "4136",
      "type": "companies",
      "attributes": {
        "name": "Organization104",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:40.165+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1273
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4138",
      "type": "companies",
      "attributes": {
        "name": "Client152",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:40.213+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1273
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a contract
GET/api/v2/contracts/{id}

URI Parameters
HideShow
id
number (required) Example: 1

contract id


POST /api/v2/contracts
Requestscreates contract and starts recurringreturns error

POST  /api/v2/contracts

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contracts",
    "attributes": {
      "interval_id": 1,
      "next_occurrence_on": "01.02.2017"
    },
    "relationships": {
      "template": {
        "data": {
          "type": "deals",
          "id": "308"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "34",
    "type": "contracts",
    "attributes": {
      "ends_on": "2017-12-31",
      "next_occurrence_on": "2017-02-01",
      "interval_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 696
        }
      },
      "template": {
        "data": {
          "type": "deals",
          "id": "520"
        }
      }
    }
  },
  "included": [
    {
      "id": "308",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2017-01-01",
        "end_date": null,
        "number": 2,
        "suffix": null,
        "time_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "e1154e30f6e0c40588a2bcdf50e654d7",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "note": null,
        "sales_closed_at": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_reimbursable": 0,
        "expense_reimbursable_default": 0,
        "expense_reimbursable_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1364
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2608"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "3616"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2610"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6965"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        }
      }
    },
    {
      "id": "2961",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user174@email.com",
        "title": null,
        "joined_at": "2017-01-01T15:00:00.000+01:00",
        "last_seen_at": "2017-01-01T15:00:00.000+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:40.517+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4139"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4142",
      "type": "companies",
      "attributes": {
        "name": "Client155",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2963",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user176@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2017-01-01T15:00:00.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4143"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "733",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 0,
        "budget_count": 1,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": "2017-01-31",
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4145"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "2964"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "4139",
      "type": "companies",
      "attributes": {
        "name": "Organization105",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:40.515+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4143",
      "type": "companies",
      "attributes": {
        "name": "Client156",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4145",
      "type": "companies",
      "attributes": {
        "name": "Client158",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2964",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user177@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2017-01-01T15:00:00.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4144"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4144",
      "type": "companies",
      "attributes": {
        "name": "Client157",
        "default_currency": null,
        "created_at": "2017-01-01T15:00:00.000+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1274
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/contracts

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contracts",
    "attributes": {
      "interval_id": 1,
      "next_occurrence_on": "2017-02-01"
    },
    "relationships": {
      "template": {
        "data": {
          "type": "deals",
          "id": "0"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "attribute is invalid",
      "source": {
        "pointer": "data/attributes/template"
      }
    }
  ]
}

Create a contract
POST/api/v2/contracts


PATCH /api/v2/contracts/1
Requestsupdates contractreturns error

PATCH  /api/v2/contracts/38

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contracts",
    "attributes": {
      "ends_on": "31.12.2017"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "38",
    "type": "contracts",
    "attributes": {
      "ends_on": null,
      "next_occurrence_on": "2017-02-01",
      "interval_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 629
        }
      },
      "template": {
        "data": {
          "type": "deals",
          "id": "273"
        }
      }
    }
  },
  "included": [
    {
      "id": "313",
      "type": "deals",
      "attributes": {
        "name": "test name",
        "date": "2020-01-16",
        "end_date": null,
        "number": 1,
        "suffix": null,
        "time_approval": true,
        "client_access": false,
        "deal_type_id": 2,
        "budget": false,
        "sales_status_id": 1,
        "sales_status_updated_at": null,
        "tag_list": [],
        "origin_deal_id": null,
        "profit_margin": 0,
        "discount": null,
        "email_key": "2f709af18e276baabdc551a8471d42e0",
        "purchase_order_number": null,
        "custom_fields": null,
        "forecasted_billable_time": 0,
        "forecasted_margin": 0,
        "forecasted_budget_usage": 0,
        "forecasted_time_usage": 0,
        "budget_usage": 0,
        "future_booked_time": 0,
        "probability": 50,
        "budget_warning": null,
        "billable_time": 0,
        "estimated_time": 0,
        "budgeted_time": 0,
        "worked_time": 0,
        "time_to_close": null,
        "unapproved_entries_count": 0,
        "estimated_remaining_time": 0,
        "unapproved_time": 0,
        "lost_comment": null,
        "closed_at": null,
        "last_activity_at": null,
        "deleted_at": null,
        "created_at": "2020-01-16T14:40:41.847+01:00",
        "note": null,
        "sales_closed_at": null,
        "note_interpolated": null,
        "todo_count": 0,
        "todo_due_date": null,
        "currency": "EUR",
        "currency_default": "USD",
        "currency_normalized": "EUR",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "services_revenue": 0,
        "services_revenue_default": 0,
        "services_revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "work_cost": 0,
        "work_cost_default": 0,
        "work_cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "invoiced": 0,
        "invoiced_default": 0,
        "invoiced_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "expense": 0,
        "expense_default": 0,
        "expense_normalized": 0,
        "expense_reimbursable": 0,
        "expense_reimbursable_default": 0,
        "expense_reimbursable_normalized": 0,
        "expense_billable": 0,
        "expense_billable_default": 0,
        "expense_billable_normalized": 0,
        "budget_total": 0,
        "budget_total_default": 0,
        "budget_total_normalized": 0,
        "budget_used": 0,
        "budget_used_default": 0,
        "budget_used_normalized": 0,
        "actual_rate": 0,
        "actual_rate_default": 0,
        "actual_rate_normalized": 0,
        "budget_remaining": 0,
        "budget_remaining_default": 0,
        "budget_remaining_normalized": 0,
        "projected_revenue": 0,
        "projected_revenue_default": 0,
        "projected_revenue_normalized": 0,
        "future_revenue": 0,
        "future_revenue_default": 0,
        "future_revenue_normalized": 0,
        "future_budget_used": 0,
        "future_budget_used_default": 0,
        "future_budget_used_normalized": 0,
        "future_cost": 0,
        "future_cost_default": 0,
        "future_cost_normalized": 0,
        "forecasted_revenue": 0,
        "forecasted_revenue_default": 0,
        "forecasted_revenue_normalized": 0,
        "forecasted_cost": 0,
        "forecasted_cost_default": 0,
        "forecasted_cost_normalized": 0,
        "forecasted_profit": 0,
        "forecasted_profit_default": 0,
        "forecasted_profit_normalized": 0,
        "forecasted_budget_used": 0,
        "forecasted_budget_used_default": 0,
        "forecasted_budget_used_normalized": 0,
        "invoiced_rate": 0,
        "invoiced_rate_default": 0,
        "invoiced_rate_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1278
          }
        },
        "creator": {
          "data": {
            "type": "people",
            "id": "2972"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4158"
          }
        },
        "document_type": {
          "data": null
        },
        "responsible": {
          "data": {
            "type": "people",
            "id": "2973"
          }
        },
        "deal_status": {
          "data": {
            "type": "deal_statuses",
            "id": "6528"
          }
        },
        "project": {
          "data": null
        },
        "lost_reason": {
          "data": null
        },
        "contract": {
          "data": null
        }
      }
    },
    {
      "id": "2972",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user185@email.com",
        "title": null,
        "joined_at": "2017-01-01T15:00:00.000+01:00",
        "last_seen_at": "2017-01-01T15:00:00.000+01:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:41.775+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1278
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4157"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "4158",
      "type": "companies",
      "attributes": {
        "name": "Client167",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:41.798+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1278
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "2973",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user186@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-01-16T14:40:41.000+01:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-01-16T14:40:41.811+01:00",
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1278
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "4159"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "6528",
      "type": "deal_statuses",
      "attributes": {
        "name": "prospective",
        "position": 6,
        "deleted_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1278
          }
        }
      }
    },
    {
      "id": "4157",
      "type": "companies",
      "attributes": {
        "name": "Organization109",
        "default_currency": "USD",
        "created_at": "2020-01-16T14:40:41.773+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1278
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "4159",
      "type": "companies",
      "attributes": {
        "name": "Client168",
        "default_currency": null,
        "created_at": "2020-01-16T14:40:41.806+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1278
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

PATCH  /api/v2/contracts/39

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "contracts",
    "attributes": {
      "next_occurrence_on": "2016-12-29"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "must be after today",
      "source": {
        "pointer": "data/attributes/next_occurrence_on"
      }
    }
  ]
}

Update a contract
PATCH/api/v2/contracts/{id}

URI Parameters
HideShow
id
number (required) Example: 1

contract id


Custom Field Options

Custom Field Options

GET /api/v2/custom_field_options
Requestsreturns custom field options

GET  /api/v2/custom_field_options

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "15",
      "type": "custom_field_options",
      "attributes": {
        "name": "High",
        "archived_at": null,
        "position": 1,
        "color_id": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1282
          }
        },
        "custom_field": {
          "data": {
            "type": "custom_fields",
            "id": "31"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "31",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1282
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "15"
            }
          ]
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/custom_field_options?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/custom_field_options?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Get custom field options
GET/api/v2/custom_field_options


GET /api/v2/custom_field_options/1
Requestsreturns custom field options

GET  /api/v2/custom_field_options/16

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "16",
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "archived_at": null,
      "position": 1,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1283
        }
      },
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "32"
        }
      }
    }
  },
  "included": [
    {
      "id": "32",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1283
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "16"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

Gets a custom field option
GET/api/v2/custom_field_options/{id}

URI Parameters
HideShow
id
number (required) Example: 1

custom field option id


POST /api/v2/custom_field_options
Requestscreates custom field optionreturns error

POST  /api/v2/custom_field_options

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "custom_field_id": 33,
      "color_id": 1
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "18",
    "type": "custom_field_options",
    "attributes": {
      "name": "High",
      "archived_at": null,
      "position": 2,
      "color_id": 1
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1284
        }
      },
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "33"
        }
      }
    }
  },
  "included": [
    {
      "id": "33",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1284
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "17"
            },
            {
              "type": "custom_field_options",
              "id": "18"
            }
          ]
        }
      }
    },
    {
      "id": "17",
      "type": "custom_field_options",
      "attributes": {
        "name": "High",
        "archived_at": null,
        "position": 1,
        "color_id": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1284
          }
        },
        "custom_field": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 0,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": false
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": false
      },
      "webhooks": {
        "type": "switch",
        "available": false
      },
      "table_pivoting": {
        "type": "switch",
        "available": false
      }
    }
  }
}

POST  /api/v2/custom_field_options

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_field_options",
    "attributes": {
      "name": "High"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/custom_field"
      }
    }
  ]
}

Creates a custom field option
POST/api/v2/custom_field_options

URI Parameters
HideShow
id
number (required) Example: 1

custom field option id


PATCH /api/v2/custom_field_options/1
Requestsupdates custom field option

PATCH  /api/v2/custom_field_options/20

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "custom_field_options",
    "attributes": {
      "name": "Low"
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "20",
    "type": "custom_field_options",
    "attributes": {
      "name": "Low",
      "archived_at": null,
      "position": 1,
      "color_id": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 1286
        }
      },
      "custom_field": {
        "data": {
          "type": "custom_fields",
          "id": "35"
        }
      }
    }
  },
  "included": [
    {
      "id": "35",
      "type": "custom_fields",
      "attributes": {
        "name": "Priority",
        "data_type_id": 3,
        "required": false,
        "description": null,
        "archived_at": null,
        "aggregation_type_id": null,
        "customizable_type": "deals"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 1286
          }
        },
        "project": {
          "data": null
        },
        "options": {
          "data": [
            {
              "type": "custom_field_options",
              "id": "20"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 3,
        "used": 1
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 1,
        "