Group Organizations

Organization is a company that have any orders from customers.

Organizations collection

GET

Retrieve list of all organizations

GET /orgs/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
      {
        "url": "/api/v2/orgs/1/",
        "name": "Test Company",
        "fees_paid_by": null,
        "insurance_charges_allowed": false,
        "app_seat_licenses": [],
        "payment_plan": {
          "url": "/api/v2/payments/plans/1/",
          "name": "",
          "price": "0.00 USD",
          "billing_period": "month",
          "limit": 1991,
          "users": -1,
          "integrations": -1,
          "storage": -1,
          "extras": []
        },
        "user_slots": 0,
        "subscriptions": {"integration": 0, "storage": 0, "user": 0},
        "avatar": null,
        "website": null
      }
    ]
}

Organization

GET

Retrieve details of specific organization

GET /orgs/{org_pk}/

Example request:

curl -iL --request GET "https://www.readycloud.com/api/v2/orgs/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

Response 200 (application/json):

{
    "url": "/api/v2/orgs/1/",
    "name": "Test Company",
    "fees_paid_by": null,
    "insurance_charges_allowed": false,
    "app_seat_licenses": [],
    "payment_plan": {
      "url": "/api/v2/payments/plans/1/",
      "name": "",
      "price": "0.00 USD",
      "billing_period": "month",
      "limit": 1991,
      "users": -1,
      "integrations": -1,
      "storage": -1,
      "extras": []
    },
    "user_slots": 0,
    "subscriptions": {"integration": 0, "storage": 0, "user": 0},
    "avatar": null,
    "website": null
}

PATCH

Update organization name

PATCH /orgs/{org_pk}/

Example request:

curl -iL --request PATCH -H "Content-Type: application/json" --upload-file data.json "https://www.readycloud.com/api/v2/orgs/1/?bearer_token=4ef5b29b1f4f35c383bebfccf4bf4d01"

data.json:

{
    "name": "New organization name"
}

Response 200 (application/json):

{
    "url": "/api/v2/orgs/1/",
    "name": "New organization name",
    "fees_paid_by": null,
    "insurance_charges_allowed": false,
    "app_seat_licenses": [],
    "payment_plan": {
      "url": "/api/v2/payments/plans/1/",
      "name": "",
      "price": "0.00 USD",
      "billing_period": "month",
      "limit": 1991,
      "users": -1,
      "integrations": -1,
      "storage": -1,
      "extras": []
    },
    "user_slots": 0,
    "subscriptions": {"integration": 0, "storage": 0, "user": 0},
    "avatar": null,
    "website": null
}