Skip to main content
GET
/
v1
/
projects
/
{projectId}
Get a single project
curl --request GET \
  --url https://api.salesnip.com/v1/projects/{projectId} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "project_abcdefghjijklmnop",
  "name": "Acme",
  "description": "[Acme] is a company that sells [product] with great quality and low prices.",
  "support": {
    "method": "EMAIL",
    "url": "https//example.com/support",
    "email": "[email protected]"
  },
  "theme": {
    "shapes": "ROUNDED",
    "light": {
      "overview": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "chat": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "primary": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "input": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "message": {
        "user": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        },
        "bot": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        }
      }
    },
    "dark": {
      "overview": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "chat": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "primary": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "input": {
        "background": "#4043ff",
        "foreground": "#4043ff"
      },
      "message": {
        "user": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        },
        "bot": {
          "background": "#4043ff",
          "foreground": "#4043ff"
        }
      }
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectId
string
required

The unique ID of the project.

Minimum string length: 1
Example:

"project_abcdefghjijklmnop"

Response

Success

​
id
string
required

The unique ID of the project.

Minimum string length: 1
Example:

"project_abcdefghjijklmnop"

​
name
string
required

The name of the project.

Required string length: 3 - 25
Example:

"Acme"

​
description
string
required

A short description of the project that helps the AI to understand the project.

Maximum string length: 1000
Example:

"[Acme] is a company that sells [product] with great quality and low prices."

​
support
object
required
​
theme
object

The theme of the SaleSnip widget. This can be used to customize the colors of the widget to match your branding.