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": "32",
      "type": "organizations",
      "attributes": {
        "name": "Organization32",
        "time_reminders": true,
        "time_reminder_id": 2,
        "time_reminder_at": 10,
        "time_reminder_condition": 100,
        "working_hours": [
          8,
          8,
          8,
          8,
          8,
          0,
          0
        ],
        "man_day_minutes": 480,
        "organization_type_id": 1,
        "invitation_token": "0059fb1995ed8fc5703ee531c76504e6",
        "due_days": 15,
        "email_key": "organization32",
        "addons": [
          "task_time_tracking",
          "time_entries_approval",
          "email_inbox",
          "project_boards",
          "invoicing",
          "subsidiaries",
          "time_tracking_estimate",
          "beta_api",
          "autotracking",
          "expenses_approvals",
          "timeoff_approvals",
          "purchase_order",
          "financial_month_locking",
          "fiscal_year"
        ],
        "flags": {},
        "time_zone": null,
        "avatar_url": null,
        "onboarding_progress": null,
        "week_start_day_id": 3,
        "weight": 0.3333333333333333,
        "metrics": "eyJzb3VyY2UiOm51bGwsIm1lZGl1bSI6bnVsbCwiY2FtcGFpZ24iOm51bGwsImNvbnRlbnQiOm51bGwsInRlcm0iOm51bGx9",
        "erector_id": null,
        "customer_success_specialist_id": null,
        "sample_data_imported_at": null,
        "sample_data_reverted_at": null,
        "verified_at": "2018-01-01T00:00:00.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,
        "force_two_factor_auth": false,
        "force_single_sign_on": false,
        "billing_email": null,
        "exchange_rate_provider_id": 1,
        "overhead_recalculation_day": 5,
        "overhead_amortization_period": 3,
        "expense_markup": 0,
        "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,
        "numbering_format_settings": {},
        "revenue_recognition_type_id": 2,
        "open_budget_recognition_date_id": 2,
        "delivered_budget_recognition_date_id": 1,
        "time_locking": false,
        "time_locking_period_id": null,
        "time_locking_interval": null,
        "time_locking_reminders": null,
        "facility_costs_breakdown": {},
        "conflict_resolver_active": true,
        "ai_enabled": true,
        "booked_demo": false,
        "allow_time_off": true,
        "subsidiary_count": 0,
        "quick_start_config": null,
        "scim_bearer_token": null,
        "locale": "en_US",
        "overhead_type_id": 1,
        "overhead": true,
        "self_attribution": null,
        "self_attribution_comment": null,
        "financial_month_locking_partial_edit": false,
        "deal_settings": {},
        "expense_settings": null,
        "financial_month_locking_date": 5,
        "financial_months": [],
        "fiscal_year_start": null,
        "timesheet_submission": false,
        "timesheet_submission_reminders": false,
        "timesheet_submission_settings": null,
        "overhead_subsidiary_switched_at": null,
        "time_tracking_policies_enabled": false,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "facility_costs": 0,
        "facility_costs_default": 0,
        "facility_costs_normalized": 0
      },
      "relationships": {
        "owner": {
          "meta": {
            "included": false
          }
        },
        "company": {
          "meta": {
            "included": false
          }
        },
        "organization_subscription": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://api-test.productive.io/api/v2/organizations?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://api-test.productive.io/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/33

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": "33",
    "type": "organizations",
    "attributes": {
      "name": "Organization33",
      "time_reminders": true,
      "time_reminder_id": 2,
      "time_reminder_at": 10,
      "time_reminder_condition": 100,
      "working_hours": [
        8,
        8,
        8,
        8,
        8,
        0,
        0
      ],
      "man_day_minutes": 480,
      "organization_type_id": 1,
      "invitation_token": "c7e194b168b8d5f6a687e8299de9c9d0",
      "due_days": 15,
      "email_key": "organization33",
      "addons": [
        "task_time_tracking",
        "time_entries_approval",
        "email_inbox",
        "project_boards",
        "invoicing",
        "subsidiaries",
        "time_tracking_estimate",
        "beta_api",
        "autotracking",
        "expenses_approvals",
        "timeoff_approvals",
        "purchase_order",
        "financial_month_locking",
        "fiscal_year"
      ],
      "flags": {},
      "time_zone": null,
      "avatar_url": null,
      "onboarding_progress": null,
      "week_start_day_id": 3,
      "weight": 0.3333333333333333,
      "metrics": "eyJzb3VyY2UiOm51bGwsIm1lZGl1bSI6bnVsbCwiY2FtcGFpZ24iOm51bGwsImNvbnRlbnQiOm51bGwsInRlcm0iOm51bGx9",
      "erector_id": null,
      "customer_success_specialist_id": null,
      "sample_data_imported_at": null,
      "sample_data_reverted_at": null,
      "verified_at": "2018-01-01T00:00:00.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,
      "force_two_factor_auth": false,
      "force_single_sign_on": false,
      "billing_email": null,
      "exchange_rate_provider_id": 1,
      "overhead_recalculation_day": 5,
      "overhead_amortization_period": 3,
      "expense_markup": 0,
      "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,
      "numbering_format_settings": {},
      "revenue_recognition_type_id": 2,
      "open_budget_recognition_date_id": 2,
      "delivered_budget_recognition_date_id": 1,
      "time_locking": false,
      "time_locking_period_id": null,
      "time_locking_interval": null,
      "time_locking_reminders": null,
      "facility_costs_breakdown": {},
      "conflict_resolver_active": true,
      "ai_enabled": true,
      "booked_demo": false,
      "allow_time_off": true,
      "subsidiary_count": 0,
      "quick_start_config": null,
      "scim_bearer_token": null,
      "locale": "en_US",
      "overhead_type_id": 1,
      "overhead": true,
      "self_attribution": null,
      "self_attribution_comment": null,
      "financial_month_locking_partial_edit": false,
      "deal_settings": {},
      "expense_settings": null,
      "financial_month_locking_date": 5,
      "financial_months": [],
      "fiscal_year_start": null,
      "timesheet_submission": false,
      "timesheet_submission_reminders": false,
      "timesheet_submission_settings": null,
      "overhead_subsidiary_switched_at": null,
      "time_tracking_policies_enabled": false,
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "facility_costs": 0,
      "facility_costs_default": 0,
      "facility_costs_normalized": 0
    },
    "relationships": {
      "owner": {
        "meta": {
          "included": false
        }
      },
      "company": {
        "meta": {
          "included": false
        }
      },
      "organization_subscription": {
        "meta": {
          "included": false
        }
      }
    }
  },
  "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/35

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

DELETE  /api/v2/organizations/46

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/51/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/52/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: 51

Generated by aglio on 21 Jul 2025