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": "38",
      "type": "organizations",
      "attributes": {
        "name": "Organization38",
        "time_reminders": true,
        "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": "9d9db3eaaa41dce27320508be35bbc58",
        "due_days": 15,
        "email_key": "organization38",
        "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": "2021-12-06T00:03:59.000+01:00",
        "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,
        "billing_email": null,
        "exchange_rate_provider_id": 1,
        "overhead_recalculation_day": 5,
        "overhead_amortization_period": 3,
        "expense_markup": 0,
        "deal_probability": 50,
        "limited_service_types": false,
        "decimal_places_id": 4,
        "analytics_uid": null,
        "currency_format_id": 1,
        "email_type_id": 1,
        "remove_branding": false,
        "email_domain_name": null,
        "email_local_name": null,
        "email_sender_name": null,
        "domain_verified": false,
        "allow_user_email": false,
        "revenue_recognition_type_id": 2,
        "open_budget_recognition_date_id": 2,
        "delivered_budget_recognition_date_id": 1,
        "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": "144"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "181"
          }
        },
        "organization_subscription": {
          "data": {
            "type": "organization_subscriptions",
            "id": "38"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "144",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user144@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 144,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:03:59.550+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "38"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "181"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "181",
      "type": "companies",
      "attributes": {
        "name": "Organization38",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:03:59.549+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "38"
          }
        }
      }
    },
    {
      "id": "38",
      "type": "organization_subscriptions",
      "attributes": {
        "billing_email": null,
        "billing_address": null,
        "subscription_state_id": 1,
        "trial_ends_at": "2021-12-20 23:59:59",
        "subscription_ends_at": null,
        "next_billing_cycle_at": null,
        "grace_period_ends_at": null,
        "plan_price": 24,
        "discount": null,
        "discount_expires_on": null,
        "plan_cycle": "month",
        "current_plan": {
          "id": "premium",
          "name": "Premium",
          "type": "regular",
          "monthly_price_cents": 2400,
          "yearly_price_cents": 24000,
          "currency": "USD",
          "upgrades": [],
          "downgrades": [
            "standard"
          ],
          "tiers": [],
          "annual_tiers": [],
          "biannual_tiers": [],
          "features": {
            "custom_fields": {
              "type": "metered",
              "limit": 15
            },
            "custom_fields_per_project": {
              "type": "metered",
              "limit": 10
            },
            "public_custom_reports": {
              "type": "metered",
              "limit": 100
            },
            "private_custom_reports": {
              "type": "metered",
              "limit": 30
            },
            "public_project_reports": {
              "type": "metered",
              "limit": 30
            },
            "private_project_reports": {
              "type": "metered",
              "limit": 10
            },
            "scheduling_placeholders": {
              "type": "metered",
              "limit": 5
            },
            "workflows": {
              "type": "metered",
              "limit": 5
            },
            "recycle_bin": {
              "type": "restricted",
              "available": true,
              "limit": 180
            },
            "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
            },
            "duplicate_tasks": {
              "type": "switch",
              "available": true
            },
            "billable_time_rounding": {
              "type": "switch",
              "available": true
            },
            "payment_sync": {
              "type": "switch",
              "available": true
            },
            "booking_methods": {
              "type": "switch",
              "available": true
            },
            "import_tasks_csv": {
              "type": "switch",
              "available": true
            },
            "reactions": {
              "type": "switch",
              "available": true
            },
            "time_week_view": {
              "type": "switch",
              "available": true
            },
            "subtasks": {
              "type": "switch",
              "available": true
            },
            "time_calendar_layout": {
              "type": "switch",
              "available": true
            },
            "theming": {
              "type": "switch",
              "available": true
            },
            "remove_branding": {
              "type": "switch",
              "available": true
            },
            "custom_invoicing_email": {
              "type": "switch",
              "available": true
            },
            "google_calendar_layout": {
              "type": "switch",
              "available": true
            },
            "pulse": {
              "type": "switch",
              "available": true
            },
            "slack": {
              "type": "switch",
              "available": true
            },
            "task_custom_fields_library": {
              "type": "switch",
              "available": true
            },
            "timeline_layout": {
              "type": "switch",
              "available": true
            },
            "comment_visibility": {
              "type": "switch",
              "available": true
            },
            "time_off_sync": {
              "type": "switch",
              "available": true
            }
          },
          "upgradeables": [],
          "downgradeables": [
            {
              "id": "standard",
              "name": "Standard",
              "type": "regular",
              "monthly_price_cents": 1500,
              "yearly_price_cents": 15000,
              "currency": "USD",
              "upgrades": [
                "premium"
              ],
              "downgrades": [],
              "tiers": [],
              "annual_tiers": [],
              "biannual_tiers": [],
              "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
                },
                "public_project_reports": {
                  "type": "metered",
                  "limit": 10
                },
                "private_project_reports": {
                  "type": "metered",
                  "limit": 5
                },
                "scheduling_placeholders": {
                  "type": "metered",
                  "limit": 0
                },
                "workflows": {
                  "type": "metered",
                  "limit": 2
                },
                "recycle_bin": {
                  "type": "restricted",
                  "available": true,
                  "limit": 7
                },
                "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
                },
                "duplicate_tasks": {
                  "type": "switch",
                  "available": true
                },
                "billable_time_rounding": {
                  "type": "switch",
                  "available": false
                },
                "payment_sync": {
                  "type": "switch",
                  "available": false
                },
                "booking_methods": {
                  "type": "switch",
                  "available": true
                },
                "import_tasks_csv": {
                  "type": "switch",
                  "available": true
                },
                "reactions": {
                  "type": "switch",
                  "available": true
                },
                "time_week_view": {
                  "type": "switch",
                  "available": true
                },
                "subtasks": {
                  "type": "switch",
                  "available": true
                },
                "time_calendar_layout": {
                  "type": "switch",
                  "available": true
                },
                "theming": {
                  "type": "switch",
                  "available": true
                },
                "remove_branding": {
                  "type": "switch",
                  "available": false
                },
                "custom_invoicing_email": {
                  "type": "switch",
                  "available": false
                },
                "google_calendar_layout": {
                  "type": "switch",
                  "available": true
                },
                "pulse": {
                  "type": "switch",
                  "available": false
                },
                "slack": {
                  "type": "switch",
                  "available": true
                },
                "task_custom_fields_library": {
                  "type": "switch",
                  "available": true
                },
                "timeline_layout": {
                  "type": "switch",
                  "available": true
                },
                "comment_visibility": {
                  "type": "switch",
                  "available": false
                },
                "time_off_sync": {
                  "type": "switch",
                  "available": true
                }
              }
            }
          ]
        },
        "plan_type": "premium",
        "payment_method_id": 1,
        "seats": 1,
        "seats_used": 1,
        "seats_pending": 1,
        "trial_plan_ends_at": null,
        "trial_plan_type": null,
        "card_brand": null,
        "card_last4": null,
        "card_month": null,
        "card_year": null,
        "stripe_customer_id": "cus_474RjipEtz2ff7",
        "balance": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "38"
          }
        }
      }
    }
  ],
  "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,
    "settings": {}
  }
}

Get organizations
GET/api/v2/organizations


GET /api/v2/organizations/1
Requestsreturns organization

GET  /api/v2/organizations/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
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "39",
    "type": "organizations",
    "attributes": {
      "name": "Organization39",
      "time_reminders": true,
      "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": "e2962b260f2e9a67ecca8764a4d9a1db",
      "due_days": 15,
      "email_key": "organization39",
      "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": "2021-12-06T00:03:59.000+01:00",
      "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,
      "billing_email": null,
      "exchange_rate_provider_id": 1,
      "overhead_recalculation_day": 5,
      "overhead_amortization_period": 3,
      "expense_markup": 0,
      "deal_probability": 50,
      "limited_service_types": false,
      "decimal_places_id": 4,
      "analytics_uid": null,
      "currency_format_id": 1,
      "email_type_id": 1,
      "remove_branding": false,
      "email_domain_name": null,
      "email_local_name": null,
      "email_sender_name": null,
      "domain_verified": false,
      "allow_user_email": false,
      "revenue_recognition_type_id": 2,
      "open_budget_recognition_date_id": 2,
      "delivered_budget_recognition_date_id": 1,
      "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": "145"
        }
      },
      "company": {
        "data": {
          "type": "companies",
          "id": "182"
        }
      },
      "organization_subscription": {
        "data": {
          "type": "organization_subscriptions",
          "id": "39"
        }
      }
    }
  },
  "included": [
    {
      "id": "145",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user145@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 145,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-12-06T00:03:59.670+01:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false,
        "last_activity_at": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "39"
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "182"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "182",
      "type": "companies",
      "attributes": {
        "name": "Organization39",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-12-06T00:03:59.668+01:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "company_code": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "39"
          }
        }
      }
    },
    {
      "id": "39",
      "type": "organization_subscriptions",
      "attributes": {
        "billing_email": null,
        "billing_address": null,
        "subscription_state_id": 1,
        "trial_ends_at": "2021-12-20 23:59:59",
        "subscription_ends_at": null,
        "next_billing_cycle_at": null,
        "grace_period_ends_at": null,
        "plan_price": 24,
        "discount": null,
        "discount_expires_on": null,
        "plan_cycle": "month",
        "current_plan": {
          "id": "premium",
          "name": "Premium",
          "type": "regular",
          "monthly_price_cents": 2400,
          "yearly_price_cents": 24000,
          "currency": "USD",
          "upgrades": [],
          "downgrades": [
            "standard"
          ],
          "tiers": [],
          "annual_tiers": [],
          "biannual_tiers": [],
          "features": {
            "custom_fields": {
              "type": "metered",
              "limit": 15
            },
            "custom_fields_per_project": {
              "type": "metered",
              "limit": 10
            },
            "public_custom_reports": {
              "type": "metered",
              "limit": 100
            },
            "private_custom_reports": {
              "type": "metered",
              "limit": 30
            },
            "public_project_reports": {
              "type": "metered",
              "limit": 30
            },
            "private_project_reports": {
              "type": "metered",
              "limit": 10
            },
            "scheduling_placeholders": {
              "type": "metered",
              "limit": 5
            },
            "workflows": {
              "type": "metered",
              "limit": 5
            },
            "recycle_bin": {
              "type": "restricted",
              "available": true,
              "limit": 180
            },
            "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
            },
            "duplicate_tasks": {
              "type": "switch",
              "available": true
            },
            "billable_time_rounding": {
              "type": "switch",
              "available": true
            },
            "payment_sync": {
              "type": "switch",
              "available": true
            },
            "booking_methods": {
              "type": "switch",
              "available": true
            },
            "import_tasks_csv": {
              "type": "switch",
              "available": true
            },
            "reactions": {
              "type": "switch",
              "available": true
            },
            "time_week_view": {
              "type": "switch",
              "available": true
            },
            "subtasks": {
              "type": "switch",
              "available": true
            },
            "time_calendar_layout": {
              "type": "switch",
              "available": true
            },
            "theming": {
              "type": "switch",
              "available": true
            },
            "remove_branding": {
              "type": "switch",
              "available": true
            },
            "custom_invoicing_email": {
              "type": "switch",
              "available": true
            },
            "google_calendar_layout": {
              "type": "switch",
              "available": true
            },
            "pulse": {
              "type": "switch",
              "available": true
            },
            "slack": {
              "type": "switch",
              "available": true
            },
            "task_custom_fields_library": {
              "type": "switch",
              "available": true
            },
            "timeline_layout": {
              "type": "switch",
              "available": true
            },
            "comment_visibility": {
              "type": "switch",
              "available": true
            },
            "time_off_sync": {
              "type": "switch",
              "available": true
            }
          },
          "upgradeables": [],
          "downgradeables": [
            {
              "id": "standard",
              "name": "Standard",
              "type": "regular",
              "monthly_price_cents": 1500,
              "yearly_price_cents": 15000,
              "currency": "USD",
              "upgrades": [
                "premium"
              ],
              "downgrades": [],
              "tiers": [],
              "annual_tiers": [],
              "biannual_tiers": [],
              "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
                },
                "public_project_reports": {
                  "type": "metered",
                  "limit": 10
                },
                "private_project_reports": {
                  "type": "metered",
                  "limit": 5
                },
                "scheduling_placeholders": {
                  "type": "metered",
                  "limit": 0
                },
                "workflows": {
                  "type": "metered",
                  "limit": 2
                },
                "recycle_bin": {
                  "type": "restricted",
                  "available": true,
                  "limit": 7
                },
                "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
                },
                "duplicate_tasks": {
                  "type": "switch",
                  "available": true
                },
                "billable_time_rounding": {
                  "type": "switch",
                  "available": false
                },
                "payment_sync": {
                  "type": "switch",
                  "available": false
                },
                "booking_methods": {
                  "type": "switch",
                  "available": true
                },
                "import_tasks_csv": {
                  "type": "switch",
                  "available": true
                },
                "reactions": {
                  "type": "switch",
                  "available": true
                },
                "time_week_view": {
                  "type": "switch",
                  "available": true
                },
                "subtasks": {
                  "type": "switch",
                  "available": true
                },
                "time_calendar_layout": {
                  "type": "switch",
                  "available": true
                },
                "theming": {
                  "type": "switch",
                  "available": true
                },
                "remove_branding": {
                  "type": "switch",
                  "available": false
                },
                "custom_invoicing_email": {
                  "type": "switch",
                  "available": false
                },
                "google_calendar_layout": {
                  "type": "switch",
                  "available": true
                },
                "pulse": {
                  "type": "switch",
                  "available": false
                },
                "slack": {
                  "type": "switch",
                  "available": true
                },
                "task_custom_fields_library": {
                  "type": "switch",
                  "available": true
                },
                "timeline_layout": {
                  "type": "switch",
                  "available": true
                },
                "comment_visibility": {
                  "type": "switch",
                  "available": false
                },
                "time_off_sync": {
                  "type": "switch",
                  "available": true
                }
              }
            }
          ]
        },
        "plan_type": "premium",
        "payment_method_id": 1,
        "seats": 1,
        "seats_used": 1,
        "seats_pending": 1,
        "trial_plan_ends_at": null,
        "trial_plan_type": null,
        "card_brand": null,
        "card_last4": null,
        "card_month": null,
        "card_year": null,
        "stripe_customer_id": "cus_474RjipEtz2ff7",
        "balance": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "39"
          }
        }
      }
    }
  ],
  "meta": {
    "settings": {}
  }
}

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/41

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/49
Requestsdeactivates organizationresends codedoes nothing

DELETE  /api/v2/organizations/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
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/49/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/50/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: 49

Generated by aglio on 05 Dec 2021