---
title: "Get Pulse configuration"
method: GET
path: "/v1/meetings/{meetingId}/pulse/metadata"
tags: ["Pulse"]
---

# Get Pulse configuration

`GET /v1/meetings/{meetingId}/pulse/metadata`

## Request

- Base URL: `https://app.meet.ps/api`
- URL: `https://app.meet.ps/api/v1/meetings/{meetingId}/pulse/metadata`
- Auth: none required

Returns the current Pulse settings for all slots, along with how many slots are currently in use. Handy when you need to decipher actual Pulse data, as pulse events types are identified by their configuration slot.

Note that slots are enumerated starting from an index of 1 (one).

## Path parameters

- `meetingId` string, required: A canonical meeting ID string that's generated automatically for new meetings. Normally consists of just alphanumericals; legacy meetings can have dashes and underscores.

## Response `200`

Pulse configuration object

- object
  - `result` PulseMetadata: Pulse feature configuration object
    - `config` object: Configuration for all Pulse buttons potentially available
      - `1` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `2` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `3` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `4` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `5` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `6` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `7` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `8` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `9` PulseMetadataSlot: Single Pulse button configuration
        - `caption` string: Pulse button caption.
        - `icon` string: Pulse icon name associated with the button.
        - `background` string: Color for the Pulse button background, in hex notation.
      - `slots` integer: Number of buttons currently enabled for the feature

## Other responses

- `404`: Reference meeting not found

---

[API](https://skmtc.dev/meet/apis/meetingpulse-api.md) · [All operations](https://skmtc.dev/meet/apis/meetingpulse-api/llms.txt) · [OpenAPI document](https://skmtc.dev/meet/apis/meetingpulse-api/revisions/dc29466adc0e?raw)