List offers

GET

/api/v1/offers

curl --request GET \
  --url 'https://api.inside.chat/api/v1/offers?website_id=example' \
  --header 'Authorization: Bearer <token>'

• Hosted Gateway
• Local development

Required scopes: conversation_read
Data access: –
MCP tool: offers

List website offers. Requires an unrestricted installation policy.

Authorizations

• installation_token
• oauth_client_credentials
  conversation_read

Parameters

Query Parameters

website_id

required

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

An explicitly granted website.

Responses

200

Authorized result. Projection depends on current scopes and data policy.

Media typeapplication/json

Unexpired website offers.

object

data

required

object

offers

required

Array<object>

object

id

required

string

offer_id

integer

label

required

string

description

Any of:

string

string

null

null

code

Any of:

string

string

null

null

image_url

Any of:

string

string

null

null

thumbnail_url

Any of:

string

string

null

null

content_type

Any of:

string

string

null

null

expires_at

Any of:

string

ISO 8601 UTC, or null when the offer has no expiry.

string

null

null

category_name

string

Example ^generated

{
  "data": {
    "offers": [
      {
        "id": "example",
        "offer_id": 1,
        "label": "example",
        "description": "example",
        "code": "example",
        "image_url": "example",
        "thumbnail_url": "example",
        "content_type": "example",
        "expires_at": "example",
        "category_name": "example"
      }
    ]
  }
}

400

Invalid, duplicate or unsupported request parameters.

401

Missing, expired or revoked installation credential.

404

Resource not found or not permitted by current authority.

422

The requested capability is not available for application installations.

429

Per-app quota exceeded.

Headers

Retry-After

integer

>= 1

503

Enrollment, native service or required authority is unavailable.