Skip to main content
GET
/
streaks
/
configs
Get paginated streak configs
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/streaks/configs \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "isEnabled": true,
      "triggerEvents": {
        "platform": [
          "achievement-completion"
        ],
        "custom": [
          "<string>"
        ]
      },
      "createdBy": "<string>",
      "updatedBy": "<string>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0
communityId
string

Response

Successful response

totalCount
number
required
edges
Streak Config · object[]
required
I