You can get a list of all applications for your HelpCrunch account. 

➡️ Request

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": 61,
            "name": "Demo iOS App",
            "displayName": "HelpCrunch iOS Demo";
            "active": true,
            "type": "ios"
        },
        {
            "id": 65,
            "name": "Demo Web App",
            "displayName": "HelpCrunch Demo";
            "active": false,
            "type": "web"
        },
        {
            "id": 70,
            "name": "Demo Android App",
            "displayName": "Android Demo";
            "active": true,
            "type": "android"
        },
        {
            "id": 71,
            "name": "17841453198752656",
            "displayName": "helpcrunch_family",
            "active": true,
            "type": "Instagram"
        },
        {
            "id": 74,
            "name": "573515439427574",
            "displayName": "HelpCrunch",
            "active": true,
            "type": "Facebook"
        },
        {
            "id": 77,
            "name": "17141453198750000",
            "displayName": "helpcrunch_team",
            "active": true,
            "type": "Instagram"
        },
        {
            "id": 79,
            "name": "pa:5752910518187380000",
            "displayName": "HelpCrunch",
            "active": true,
            "type": "Viber"
        }
    ],
  "meta": {
  "total": 10
  }
}

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

🛑 Error Responses

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

400 Bad Request

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "customer",
      "message": "This value should be of type numeric."
    },
    {
      "code": "filter[0].field",
      "message": "This value should not be blank."
    }
  ]
}

401 Unauthorized

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

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! 👨‍💻