Get team availability status

Fetch info about your team online/offline status
Written by Konstantine
Updated 1 month ago

This method returns some basic information about your team together with the states of these two switchers:

➡️ Request

URL https://api.helpcrunch.com/v1/organization
Method GET
Headers Authorization: Bearer <your_api_key>

Read more about authorization header here.


✅ Successful Response

If your request has succeeded, you'll get a 200 OK success status code together with the following response body.

{
  "data": {
    "id": 542335,
    "domain": "string",
    "teamOnline": true,
    "chatEnabled": true
  }
}

You can get details on every Organization Object field in the Organization model article.

🛑 Error Responses

You may get one of the following error status codes and responses. More info on the errors is available here.

401 Unauthorized

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "unauthorized",
      "message": "Unauthorized"
    }
  ]
}

404 Unauthorized

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "not_found",
      "message": "Chat not found"
    }
  ]
}

429 Too Many Requests

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "too_many_requests",
      "message": "Too many requests"
    }
  ]
}

If you have any questions regarding the REST API, feel free to chat us any time.

👩‍💻 Happy Coding! 👨‍💻

Did this answer your question?