API Documentation

API Endpoint

Organizations

Organizations

GET /api/v2/organizations
Requestsreturns organizations

GET  /api/v2/organizations

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": "22",
      "type": "organizations",
      "attributes": {
        "name": "Organization22",
        "time_reminder_id": 2,
        "time_reminder_at": 10,
        "time_reminder_condition": 100,
        "working_days": [],
        "working_hours": [
          8,
          8,
          8,
          8,
          8,
          0,
          0
        ],
        "man_day_minutes": 480,
        "organization_type_id": 1,
        "invitation_token": "c19fbbdd6d0910c1200055542c8748f0",
        "due_days": 15,
        "email_key": "organization22",
        "addons": [
          "task_time_tracking",
          "time_entries_approval",
          "email_inbox",
          "project_boards",
          "invoicing",
          "subsidiaries",
          "overhead",
          "time_tracking_estimate",
          "sidebar",
          "beta_api",
          "autotracking",
          "expenses_approvals",
          "timeoff_approvals"
        ],
        "time_zone": null,
        "avatar_url": null,
        "onboarding_progress": null,
        "week_start_day_id": 3,
        "weight": 1,
        "metrics": "eyJzb3VyY2UiOm51bGwsIm1lZGl1bSI6bnVsbCwiY2FtcGFpZ24iOm51bGwsImNvbnRlbnQiOm51bGx9",
        "erector_id": null,
        "sample_data_imported_at": null,
        "sample_data_reverted_at": null,
        "verified_at": "2020-08-11T01:03:47.000+02:00",
        "features": {
          "custom_fields": {
            "type": "metered",
            "limit": 15,
            "used": 0
          },
          "custom_fields_per_project": {
            "type": "metered",
            "limit": 10,
            "used": 0
          },
          "public_custom_reports": {
            "type": "metered",
            "limit": 30,
            "used": 0
          },
          "private_custom_reports": {
            "type": "metered",
            "limit": 30,
            "used": 0
          },
          "scheduling_placeholders": {
            "type": "metered",
            "limit": 5,
            "used": 0
          },
          "multigrouping": {
            "type": "switch",
            "available": true
          },
          "client_access_to_budgets": {
            "type": "switch",
            "available": true
          },
          "subsidiaries": {
            "type": "switch",
            "available": true
          },
          "time_approvals": {
            "type": "switch",
            "available": true
          },
          "expenses_approvals": {
            "type": "switch",
            "available": true
          },
          "timeoff_approvals": {
            "type": "switch",
            "available": true
          },
          "autotracking": {
            "type": "switch",
            "available": true
          },
          "forecasting": {
            "type": "switch",
            "available": true
          },
          "webhooks": {
            "type": "switch",
            "available": true
          },
          "table_pivoting": {
            "type": "switch",
            "available": true
          },
          "formula_fields": {
            "type": "switch",
            "available": true
          },
          "single_sign_on": {
            "type": "switch",
            "available": true
          }
        },
        "time_format_id": 1,
        "number_format_id": 1,
        "date_format_id": 1,
        "time_display_id": 1,
        "rounding_method_id": 1,
        "rounding_interval_id": null,
        "single_sign_on": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "facility_costs": 0,
        "facility_costs_default": 0,
        "facility_costs_normalized": 0
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "people",
            "id": "74"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "111"
          }
        },
        "organization_subscription": {
          "data": {
            "type": "organization_subscriptions",
            "id": "22"
          }
        },
        "bill_from": {
          "data": null
        },
        "billing_email": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "74",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user74@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "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-08-11T01:03:47.105+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 22
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "111"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "111",
      "type": "companies",
      "attributes": {
        "name": "Organization22",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:03:47.104+02: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": 22
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "22",
      "type": "organization_subscriptions",
      "attributes": {
        "billing_email": null,
        "billing_address": null,
        "subscription_state_id": 1,
        "trial_ends_at": "2020-08-25 23:59:59",
        "subscription_ends_at": null,
        "next_billing_cycle_at": null,
        "grace_period_ends_at": null,
        "plan_price": 24,
        "monthly_plan_price": 24,
        "yearly_plan_price": 240,
        "discount": null,
        "discount_expires_on": null,
        "plan_cycle": "month",
        "plan_type": "premium",
        "downgrades": [
          {
            "id": "standard",
            "name": "Standard",
            "type": "regular",
            "monthly_price_cents": 1500,
            "yearly_price_cents": 15000,
            "currency": "USD",
            "upgrades": [
              "premium"
            ],
            "downgrades": [],
            "features": {
              "custom_fields": {
                "type": "metered",
                "limit": 3
              },
              "custom_fields_per_project": {
                "type": "metered",
                "limit": 1
              },
              "public_custom_reports": {
                "type": "metered",
                "limit": 10
              },
              "private_custom_reports": {
                "type": "metered",
                "limit": 10
              },
              "scheduling_placeholders": {
                "type": "metered",
                "limit": 0
              },
              "multigrouping": {
                "type": "switch",
                "available": false
              },
              "client_access_to_budgets": {
                "type": "switch",
                "available": false
              },
              "subsidiaries": {
                "type": "switch",
                "available": false
              },
              "time_approvals": {
                "type": "switch",
                "available": false
              },
              "expenses_approvals": {
                "type": "switch",
                "available": false
              },
              "timeoff_approvals": {
                "type": "switch",
                "available": false
              },
              "autotracking": {
                "type": "switch",
                "available": false
              },
              "forecasting": {
                "type": "switch",
                "available": false
              },
              "webhooks": {
                "type": "switch",
                "available": false
              },
              "table_pivoting": {
                "type": "switch",
                "available": false
              },
              "formula_fields": {
                "type": "switch",
                "available": false
              },
              "single_sign_on": {
                "type": "switch",
                "available": false
              }
            }
          }
        ],
        "current_plan": {
          "id": "premium",
          "name": "Premium",
          "type": "regular",
          "monthly_price_cents": 2400,
          "yearly_price_cents": 24000,
          "currency": "USD",
          "upgrades": [],
          "downgrades": [
            "standard"
          ],
          "features": {
            "custom_fields": {
              "type": "metered",
              "limit": 15,
              "used": 0
            },
            "custom_fields_per_project": {
              "type": "metered",
              "limit": 10,
              "used": 0
            },
            "public_custom_reports": {
              "type": "metered",
              "limit": 30,
              "used": 0
            },
            "private_custom_reports": {
              "type": "metered",
              "limit": 30,
              "used": 0
            },
            "scheduling_placeholders": {
              "type": "metered",
              "limit": 5,
              "used": 0
            },
            "multigrouping": {
              "type": "switch",
              "available": true
            },
            "client_access_to_budgets": {
              "type": "switch",
              "available": true
            },
            "subsidiaries": {
              "type": "switch",
              "available": true
            },
            "time_approvals": {
              "type": "switch",
              "available": true
            },
            "expenses_approvals": {
              "type": "switch",
              "available": true
            },
            "timeoff_approvals": {
              "type": "switch",
              "available": true
            },
            "autotracking": {
              "type": "switch",
              "available": true
            },
            "forecasting": {
              "type": "switch",
              "available": true
            },
            "webhooks": {
              "type": "switch",
              "available": true
            },
            "table_pivoting": {
              "type": "switch",
              "available": true
            },
            "formula_fields": {
              "type": "switch",
              "available": true
            },
            "single_sign_on": {
              "type": "switch",
              "available": true
            }
          }
        },
        "upgrades": [],
        "payment_method_id": 1,
        "employee_count": 1,
        "seats": null,
        "seats_used": 1,
        "trial_plan_ends_at": null,
        "trial_plan_type": null,
        "card_brand": null,
        "card_last4": null,
        "card_month": null,
        "card_year": null,
        "balance": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 22
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/organizations?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/organizations?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
  }
}

Get organizations
GET/api/v2/organizations

GET /api/v2/organizations/1
Requestsreturns organization

GET  /api/v2/organizations/23

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": "23",
    "type": "organizations",
    "attributes": {
      "name": "Organization23",
      "time_reminder_id": 2,
      "time_reminder_at": 10,
      "time_reminder_condition": 100,
      "working_days": [],
      "working_hours": [
        8,
        8,
        8,
        8,
        8,
        0,
        0
      ],
      "man_day_minutes": 480,
      "organization_type_id": 1,
      "invitation_token": "4738aa5739e58ca0af9143315de0fdf9",
      "due_days": 15,
      "email_key": "organization23",
      "addons": [
        "task_time_tracking",
        "time_entries_approval",
        "email_inbox",
        "project_boards",
        "invoicing",
        "subsidiaries",
        "overhead",
        "time_tracking_estimate",
        "sidebar",
        "beta_api",
        "autotracking",
        "expenses_approvals",
        "timeoff_approvals"
      ],
      "time_zone": null,
      "avatar_url": null,
      "onboarding_progress": null,
      "week_start_day_id": 3,
      "weight": 1,
      "metrics": "eyJzb3VyY2UiOm51bGwsIm1lZGl1bSI6bnVsbCwiY2FtcGFpZ24iOm51bGwsImNvbnRlbnQiOm51bGx9",
      "erector_id": null,
      "sample_data_imported_at": null,
      "sample_data_reverted_at": null,
      "verified_at": "2020-08-11T01:03:47.000+02:00",
      "features": {
        "custom_fields": {
          "type": "metered",
          "limit": 15,
          "used": 0
        },
        "custom_fields_per_project": {
          "type": "metered",
          "limit": 10,
          "used": 0
        },
        "public_custom_reports": {
          "type": "metered",
          "limit": 30,
          "used": 0
        },
        "private_custom_reports": {
          "type": "metered",
          "limit": 30,
          "used": 0
        },
        "scheduling_placeholders": {
          "type": "metered",
          "limit": 5,
          "used": 0
        },
        "multigrouping": {
          "type": "switch",
          "available": true
        },
        "client_access_to_budgets": {
          "type": "switch",
          "available": true
        },
        "subsidiaries": {
          "type": "switch",
          "available": true
        },
        "time_approvals": {
          "type": "switch",
          "available": true
        },
        "expenses_approvals": {
          "type": "switch",
          "available": true
        },
        "timeoff_approvals": {
          "type": "switch",
          "available": true
        },
        "autotracking": {
          "type": "switch",
          "available": true
        },
        "forecasting": {
          "type": "switch",
          "available": true
        },
        "webhooks": {
          "type": "switch",
          "available": true
        },
        "table_pivoting": {
          "type": "switch",
          "available": true
        },
        "formula_fields": {
          "type": "switch",
          "available": true
        },
        "single_sign_on": {
          "type": "switch",
          "available": true
        }
      },
      "time_format_id": 1,
      "number_format_id": 1,
      "date_format_id": 1,
      "time_display_id": 1,
      "rounding_method_id": 1,
      "rounding_interval_id": null,
      "single_sign_on": false,
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "facility_costs": 0,
      "facility_costs_default": 0,
      "facility_costs_normalized": 0
    },
    "relationships": {
      "owner": {
        "data": {
          "type": "people",
          "id": "75"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "112"
        }
      },
      "organization_subscription": {
        "data": {
          "type": "organization_subscriptions",
          "id": "23"
        }
      },
      "bill_from": {
        "data": null
      },
      "billing_email": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "75",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user75@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "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-08-11T01:03:47.217+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 23
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "112"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "112",
      "type": "companies",
      "attributes": {
        "name": "Organization23",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:03:47.216+02: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": 23
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "23",
      "type": "organization_subscriptions",
      "attributes": {
        "billing_email": null,
        "billing_address": null,
        "subscription_state_id": 1,
        "trial_ends_at": "2020-08-25 23:59:59",
        "subscription_ends_at": null,
        "next_billing_cycle_at": null,
        "grace_period_ends_at": null,
        "plan_price": 24,
        "monthly_plan_price": 24,
        "yearly_plan_price": 240,
        "discount": null,
        "discount_expires_on": null,
        "plan_cycle": "month",
        "plan_type": "premium",
        "downgrades": [
          {
            "id": "standard",
            "name": "Standard",
            "type": "regular",
            "monthly_price_cents": 1500,
            "yearly_price_cents": 15000,
            "currency": "USD",
            "upgrades": [
              "premium"
            ],
            "downgrades": [],
            "features": {
              "custom_fields": {
                "type": "metered",
                "limit": 3
              },
              "custom_fields_per_project": {
                "type": "metered",
                "limit": 1
              },
              "public_custom_reports": {
                "type": "metered",
                "limit": 10
              },
              "private_custom_reports": {
                "type": "metered",
                "limit": 10
              },
              "scheduling_placeholders": {
                "type": "metered",
                "limit": 0
              },
              "multigrouping": {
                "type": "switch",
                "available": false
              },
              "client_access_to_budgets": {
                "type": "switch",
                "available": false
              },
              "subsidiaries": {
                "type": "switch",
                "available": false
              },
              "time_approvals": {
                "type": "switch",
                "available": false
              },
              "expenses_approvals": {
                "type": "switch",
                "available": false
              },
              "timeoff_approvals": {
                "type": "switch",
                "available": false
              },
              "autotracking": {
                "type": "switch",
                "available": false
              },
              "forecasting": {
                "type": "switch",
                "available": false
              },
              "webhooks": {
                "type": "switch",
                "available": false
              },
              "table_pivoting": {
                "type": "switch",
                "available": false
              },
              "formula_fields": {
                "type": "switch",
                "available": false
              },
              "single_sign_on": {
                "type": "switch",
                "available": false
              }
            }
          }
        ],
        "current_plan": {
          "id": "premium",
          "name": "Premium",
          "type": "regular",
          "monthly_price_cents": 2400,
          "yearly_price_cents": 24000,
          "currency": "USD",
          "upgrades": [],
          "downgrades": [
            "standard"
          ],
          "features": {
            "custom_fields": {
              "type": "metered",
              "limit": 15,
              "used": 0
            },
            "custom_fields_per_project": {
              "type": "metered",
              "limit": 10,
              "used": 0
            },
            "public_custom_reports": {
              "type": "metered",
              "limit": 30,
              "used": 0
            },
            "private_custom_reports": {
              "type": "metered",
              "limit": 30,
              "used": 0
            },
            "scheduling_placeholders": {
              "type": "metered",
              "limit": 5,
              "used": 0
            },
            "multigrouping": {
              "type": "switch",
              "available": true
            },
            "client_access_to_budgets": {
              "type": "switch",
              "available": true
            },
            "subsidiaries": {
              "type": "switch",
              "available": true
            },
            "time_approvals": {
              "type": "switch",
              "available": true
            },
            "expenses_approvals": {
              "type": "switch",
              "available": true
            },
            "timeoff_approvals": {
              "type": "switch",
              "available": true
            },
            "autotracking": {
              "type": "switch",
              "available": true
            },
            "forecasting": {
              "type": "switch",
              "available": true
            },
            "webhooks": {
              "type": "switch",
              "available": true
            },
            "table_pivoting": {
              "type": "switch",
              "available": true
            },
            "formula_fields": {
              "type": "switch",
              "available": true
            },
            "single_sign_on": {
              "type": "switch",
              "available": true
            }
          }
        },
        "upgrades": [],
        "payment_method_id": 1,
        "employee_count": 1,
        "seats": null,
        "seats_used": 1,
        "trial_plan_ends_at": null,
        "trial_plan_type": null,
        "card_brand": null,
        "card_last4": null,
        "card_month": null,
        "card_year": null,
        "balance": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 23
          }
        }
      }
    }
  ],
  "meta": {}
}

Gets a organization
GET/api/v2/organizations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

organization id

PATCH /api/v2/organizations/1
Requestsreturns error

PATCH  /api/v2/organizations/25

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": "organizations",
    "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 organization
PATCH/api/v2/organizations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

organization id

DELETE /api/v2/organizations/33
Requestsdeactivates organizationresends codedoes nothing

DELETE  /api/v2/organizations/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": "organizations",
    "attributes": {
      "deactivation_reason_id": 2,
      "deactivation_note": "why i left productive"
    }
  }
}
Responses204
This response has no content.

PATCH  /api/v2/organizations/33/resend_code

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
{}
Responses204
This response has no content.

PATCH  /api/v2/organizations/34/resend_code

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
{}
Responses204
This response has no content.

Deletes a organization
DELETE/api/v2/organizations/{id}

URI Parameters
HideShow
id
number (required) Example: 33

Generated by aglio on 10 Aug 2020