Get current project

GET

/projects/current

const url = 'https://api.siteassist.io/v2/projects/current?apiKey=sa_pk_1234567890abcdef';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.siteassist.io/v2/projects/current?apiKey=sa_pk_1234567890abcdef'

Return the current project identified by the provided publishable API key. Useful for initializing client SDKs with project configuration like chat widget settings.

Parameters

Query Parameters

apiKey

required

Publishable API key identifying the project

string

Example

sa_pk_1234567890abcdef

Responses

200

Successfully retrieved the project

application/json

The current project object including effective chat widget configuration.

object

object

string

default: project

Allowed values: project

required

string format: uuid

name

required

string

<= 100 characters

description

required

string

nullable <= 500 characters

chatWidgetConfig

required

object

welcomeMessage

required

string

<= 500 characters

inputPlaceholder

required

string

<= 100 characters

userMessageBubbleColor

required

string

<= 64 characters

userMessageBubbleColorDark

required

string

nullable <= 64 characters

brandColor

required

string

<= 64 characters

brandColorDark

required

string

nullable <= 64 characters

displayName

required

string

nullable

width

required

number

maxHeight

required

number

offset

required

object

required

number

required

number

position

required

string

Allowed values: bottom-left bottom-right

bubbleRadius

required

number

baseFontSize

required

number

>= 8 <= 32

openDelay

required

number

assistantAvatar

string format: uri

nullable

chatButtonIcon

string format: uri

nullable

chatButtonColor

string

nullable

customCSSStyles

required

string

Example

{
  "id": "e2c6b2ad-9b1f-4f3c-8f5a-9f2a7b1c2d3e",
  "name": "Acme Inc",
  "status": "active",
  "chatWidgetConfig": {
    "position": "right",
    "theme": "light",
    "welcomeMessage": "Hi! How can we help?"
  }
}

400

Bad request

401

Unauthorized

403

Forbidden

404

Requested resource not found.

500

Internal server error