GET
/
v5
/
app
/
experiences
curl --request GET \
  --url https://{defaultHost}/v5/app/experiences \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "created_at": 123,
      "name": "<string>",
      "company_id": "<string>",
      "product_ids": [
        "<string>"
      ],
      "app_id": "<string>",
      "app_icon_url": "<string>",
      "access_level": "<string>",
      "features": [
        "<string>"
      ],
      "metadata": {},
      "hub_url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Query Parameters

​
company_id
string

An ID of a company to filter by, which will look like biz_*************

​
product_id
string

An ID of a product to filter by, which will look like prod_*************

​
page
integer
default:1

The page number to retrieve

​
per
integer
default:10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

A successful response

The response is of type object.

GET
/
v5
/
app
/
experiences
curl --request GET \
  --url https://{defaultHost}/v5/app/experiences \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "created_at": 123,
      "name": "<string>",
      "company_id": "<string>",
      "product_ids": [
        "<string>"
      ],
      "app_id": "<string>",
      "app_icon_url": "<string>",
      "access_level": "<string>",
      "features": [
        "<string>"
      ],
      "metadata": {},
      "hub_url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Query Parameters

​
company_id
string

An ID of a company to filter by, which will look like biz_*************

​
product_id
string

An ID of a product to filter by, which will look like prod_*************

​
page
integer
default:1

The page number to retrieve

​
per
integer
default:10

The number of resources to return per page. There is a limit of 50 results per page.

Response

200 - application/json

A successful response

The response is of type object.