Fetches all dashboards.

curl --request GET \
  --url https://api.homepal.se/v1/third-party/dashboards \
  --header 'X-API-KEY: <api-key>'

{
  "data": {
    "dashboards": [
      {
        "id": "01fe4ce4-3057-46eb-8355-5ebebbe8c263",
        "folder": "Uthyrning",
        "title": "Vakanser",
        "tab": "Alla",
        "url": "http://localhost:3000/api-access/dashboards/01fe4ce4-3057-46eb-8355-5ebebbe8c263?token=eyJh...Avs",
        "preview_widgets": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "Antal hyresavtal",
            "url": "http://localhost:3000/api-access/widgets/166694b3-c31c-4fbf-89dd-d4ecb49a4a4d?token=eyJh...Avs",
            "raw": {
              "url": "http://localhost:3000/api-access/widgets/166694b3-c31c-4fbf-89dd-d4ecb49a",
              "headers": {
                "Authorization": "Bearer eyJh...Avs"
              }
            }
          }
        ],
        "custom_fields": [
          {
            "field_name": "section_title",
            "value": "Hyresdata"
          }
        ]
      }
    ],
    "links_expire_in": 3600,
    "meta": {
      "available_query_params": {
        "filter": {
          "type": "boolean",
          "default": "false"
        },
        "export": {
          "type": "boolean",
          "default": "false"
        },
        "responsive_mode": {
          "type": "enum",
          "enum": [
            "desktop",
            "mobile"
          ],
          "default": "desktop"
        },
        "mobile_breakpoint": {
          "type": "number",
          "default": "768"
        },
        "hide_footer": {
          "type": false,
          "default": false
        },
        "font_family": {
          "type": "enum",
          "enum": [
            "Source Sans 3",
            "UnitOTRB"
          ],
          "default": "Source Sans 3"
        },
        "companies": {
          "type": "enum",
          "enum": [
            "Company 1",
            "Company 2"
          ],
          "default": null
        }
      }
    }
  }
}

GET

third-party

dashboards

Fetches all dashboards.

curl --request GET \
  --url https://api.homepal.se/v1/third-party/dashboards \
  --header 'X-API-KEY: <api-key>'

{
  "data": {
    "dashboards": [
      {
        "id": "01fe4ce4-3057-46eb-8355-5ebebbe8c263",
        "folder": "Uthyrning",
        "title": "Vakanser",
        "tab": "Alla",
        "url": "http://localhost:3000/api-access/dashboards/01fe4ce4-3057-46eb-8355-5ebebbe8c263?token=eyJh...Avs",
        "preview_widgets": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "title": "Antal hyresavtal",
            "url": "http://localhost:3000/api-access/widgets/166694b3-c31c-4fbf-89dd-d4ecb49a4a4d?token=eyJh...Avs",
            "raw": {
              "url": "http://localhost:3000/api-access/widgets/166694b3-c31c-4fbf-89dd-d4ecb49a",
              "headers": {
                "Authorization": "Bearer eyJh...Avs"
              }
            }
          }
        ],
        "custom_fields": [
          {
            "field_name": "section_title",
            "value": "Hyresdata"
          }
        ]
      }
    ],
    "links_expire_in": 3600,
    "meta": {
      "available_query_params": {
        "filter": {
          "type": "boolean",
          "default": "false"
        },
        "export": {
          "type": "boolean",
          "default": "false"
        },
        "responsive_mode": {
          "type": "enum",
          "enum": [
            "desktop",
            "mobile"
          ],
          "default": "desktop"
        },
        "mobile_breakpoint": {
          "type": "number",
          "default": "768"
        },
        "hide_footer": {
          "type": false,
          "default": false
        },
        "font_family": {
          "type": "enum",
          "enum": [
            "Source Sans 3",
            "UnitOTRB"
          ],
          "default": "Source Sans 3"
        },
        "companies": {
          "type": "enum",
          "enum": [
            "Company 1",
            "Company 2"
          ],
          "default": null
        }
      }
    }
  }
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

company_group_id

string

required

Fetches all dashboards that the company group can view through a third party.

Response

200 - application/json

All the company groups dashboards

data

object

Show child attributes

data.dashboards

object[]

Show child attributes

data.dashboards.id

string

Example:

"01fe4ce4-3057-46eb-8355-5ebebbe8c263"

data.dashboards.folder

string | null

Example:

"Uthyrning"

data.dashboards.title

string

Example:

"Vakanser"

data.dashboards.tab

string

Example:

"Alla"

data.dashboards.url

string

The url to use in the iframe.

Example:

"http://localhost:3000/api-access/dashboards/01fe4ce4-3057-46eb-8355-5ebebbe8c263?token=eyJh...Avs"

data.dashboards.preview_widgets

object[]

Widgets that can be fetched on their own as previews.

Show child attributes

data.dashboards.preview_widgets.id

string<uuid>

data.dashboards.preview_widgets.title

string

Example:

"Antal hyresavtal"

data.dashboards.preview_widgets.url

string

Example:

"http://localhost:3000/api-access/widgets/166694b3-c31c-4fbf-89dd-d4ecb49a4a4d?token=eyJh...Avs"

data.dashboards.preview_widgets.raw

object

Show child attributes

data.dashboards.preview_widgets.raw.url

string

Example:

"http://localhost:3000/api-access/widgets/166694b3-c31c-4fbf-89dd-d4ecb49a"

data.dashboards.preview_widgets.raw.headers

object

Show child attributes

data.dashboards.preview_widgets.raw.headers.Authorization

string

Example:

"Bearer eyJh...Avs"

data.dashboards.custom_fields

object[]

A list of custom fields that have been added to the dashboard.

Show child attributes

data.dashboards.custom_fields.field_name

string

Example:

"section_title"

data.dashboards.custom_fields.value

string

Example:

"Hyresdata"

data.links_expire_in

number

Example:

3600

data.meta

object

Show child attributes

data.meta.available_query_params

object

Show child attributes

data.meta.available_query_params.filter

object

Show child attributes

data.meta.available_query_params.filter.type

string

Example:

"boolean"

data.meta.available_query_params.filter.default

string

Example:

"false"

data.meta.available_query_params.export

object

Show child attributes

data.meta.available_query_params.export.type

string

Example:

"boolean"

data.meta.available_query_params.export.default

string

Example:

"false"

data.meta.available_query_params.responsive_mode

object

Sets the type of responsive mode. mobile to switch to mobile view on small screens, desktop to constantly use desktop view.

Show child attributes

data.meta.available_query_params.responsive_mode.type

string

Example:

"enum"

data.meta.available_query_params.responsive_mode.enum

string[]

Example:

["desktop", "mobile"]

data.meta.available_query_params.responsive_mode.default

string

Example:

"desktop"

data.meta.available_query_params.mobile_breakpoint

object

Specifies at what value (expressed in px) responsive mode should take effect. Requires responsive_mode to be set to mobile.

Show child attributes

data.meta.available_query_params.mobile_breakpoint.type

string

Example:

"number"

data.meta.available_query_params.mobile_breakpoint.default

string

Example:

"768"

data.meta.available_query_params.hide_footer

object

Determines whether the dashboard footer is hidden. If set to true, the footer will not be displayed. This can be used to simplify the layout or improve usability in certain scenarios.

Show child attributes

data.meta.available_query_params.hide_footer.type

boolean

Example:

false

data.meta.available_query_params.hide_footer.default

boolean

Example:

false

data.meta.available_query_params.font_family

object

Specifies the font family to be used in the dashboard.

Show child attributes

data.meta.available_query_params.font_family.type

string

Example:

"enum"

data.meta.available_query_params.font_family.enum

string[]

Example:

["Source Sans 3", "UnitOTRB"]

data.meta.available_query_params.font_family.default

string

Example:

"Source Sans 3"

data.meta.available_query_params.companies

object

A comma separted list of company names to filter the data by. If not set, data from all companies the company group has access to will be shown.

Show child attributes

data.meta.available_query_params.companies.type

string

Example:

"enum"

data.meta.available_query_params.companies.enum

string[]

Example:

["Company 1", "Company 2"]

data.meta.available_query_params.companies.default

string

Example:

null

Raw widgets Fetches one raw API-access widget.

⌘I

Guide

API Reference

Fetches all dashboards.

Authorizations

Query Parameters

Response