Get a beacon

GET /projects/{projectId}/beacons/{beaconId}

Authentication

API Key (header: X-API-Key)

Path Parameters

projectId string required path

beaconId string required path

Responses

200 Beacon details

application/json

data object

id string

project_id string

form_id string

position string

Enum: bottom-right, bottom-left

primary_color string

button_label string

button_icon string

Enum: chat, mail, help, custom_svg

custom_svg string | null

greeting_title string

greeting_text string

allowed_origins string[]

Array of:

archived_at string (date-time) | null

created_at string (date-time)

404 Not found

curl -X GET 'https://api.rogeriq.com/api/v1/projects/string/beacons/string' \  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.rogeriq.com/api/v1/projects/string/beacons/string', {  method: 'GET',  headers: {      "Authorization": "Bearer YOUR_API_TOKEN"  }});const data = await response.json();console.log(data);

import requestsheaders = {    'Authorization': 'Bearer YOUR_API_TOKEN'}response = requests.get('https://api.rogeriq.com/api/v1/projects/string/beacons/string', headers=headers)print(response.json())

200 Response

{  "data": {    "id": "<string>",    "project_id": "<string>",    "form_id": "<string>",    "position": "bottom-right",    "primary_color": "<string>",    "button_label": "<string>",    "button_icon": "chat",    "custom_svg": "<string>",    "greeting_title": "<string>",    "greeting_text": "<string>",    "allowed_origins": [      "<string>"    ],    "archived_at": "2024-01-01T00:00:00Z",    "created_at": "2024-01-01T00:00:00Z"  }}

GET /projects/{projectId}/beacons/{beaconId}

Base URL

Bearer Token

Path Parameters

projectId string required

beaconId string required

Response

Was this page helpful?

Previous Create a beacon

Next Update a beacon