Skip to content

List NPS campaigns

GET/support/nps-campaigns

Returns all Net Promoter Score (NPS) campaigns. Each campaign defines a periodic survey sent to a subset of customers to measure loyalty. Use this to track campaign schedules and response rates over time.

Request

This endpoint takes no parameters and no request body.

Responses

200 List of NPS campaigns

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · NpsCampaignV1No
data[].idintegerNo

Auto-incremented primary key.

data[].namestringNo

Campaign name.

Example: "Q2 2026 NPS"

data[].statusstringNo

Campaign lifecycle status.

One of: "active", "inactive", "draft" · Example: "active"

data[].response_countintegerNo

Total responses collected for this campaign.

Example: 84

data[].avg_scorenumber, nullableNo

Average NPS score across all responses (0–10).

Example: 7.4

data[].created_atstring (date-time)No

Record creation timestamp.

Example

{
  "data": [
    {
      "id": 2,
      "name": "Q2 2026 NPS",
      "status": "active",
      "response_count": 84,
      "avg_score": 7.4,
      "created_at": "2026-04-01T08:00:00Z"
    }
  ]
}

401 Unauthenticated

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/support/nps-campaigns" \
  -H "Accept: application/json"
Loading