Turf API Documentation
  1. Channels
Turf API Documentation
  • Users
    • Create Community Member
      POST
    • Update Community Member's Profile
      PUT
    • Get Community Members
      GET
    • Block Community Member
      PUT
    • Get Community Member's Details
      GET
    • Get Member's Created Posts
      GET
    • Get Member's Saved Posts
      GET
    • Get Member's Comments
      GET
  • Channels
    • Get Community Channels
      GET
  • Posts
    • Create Discussion Post
      POST
    • Update Discussion Post
      PUT
    • Create Article Post
      POST
    • Update Article Post
      PUT
    • Create Comment On Post
      POST
    • Update Comment On Post
      PUT
    • Delete Existing Comment
      DELETE
    • Top Community Posts
      GET
    • Get Channel's Posts
      GET
    • Get Discussion Post Details
      GET
    • Get Article Post Details
      GET
    • Create comment on comment
      POST
  • Courses
    • Top Community Courses
      GET
  • Segments
    • Get Community Segments
      GET
    • Add Member To Segment
      POST
    • Remove Member From Segment
      DELETE
  • Gamification
    • Get Community Badges
    • Award Badge To Member
    • Remove Badge From Member
  1. Channels

Get Community Channels

GET
https://2e0a7m2i9j.execute-api.eu-central-1.amazonaws.com/prod/community/v1/channels
The Get Community Channels API retrieves a list of all channels listed in your community environment. The API returns essential details for each channel, including channel ID and channel name.

Request

Header Params

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://2e0a7m2i9j.execute-api.eu-central-1.amazonaws.com/prod/community/v1/channels' \
--header 'x-api-key: api_key'
Response Response Example
200 - Example 1
{
    "message": "Success",
    "data": [
        {
            "id": 247,
            "tab_name": "Start",
            "type": "public",
            "channels": [
                {
                    "channel_name": "Welcome",
                    "type": "private",
                    "resource_type": "single",
                    "position": 1,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Welcome\"},\"nl\":{\"title\":\"\",\"post\":\"Welkom\"},\"fr\":{\"title\":\"\",\"post\":\"Accueillir\"},\"es\":{\"title\":\"\",\"post\":\"Bienvenido\"},\"pt\":{\"title\":\"\",\"post\":\"Bem-vindo\"}}",
                    "id": "welcome"
                }
            ]
        },
        {
            "id": 250,
            "tab_name": "Product",
            "type": "public",
            "channels": [
                {
                    "channel_name": "Support",
                    "type": "private",
                    "resource_type": "general",
                    "position": 1,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Support\"},\"nl\":{\"title\":\"\",\"post\":\"Steun\"},\"fr\":{\"title\":\"\",\"post\":\"Soutien\"},\"es\":{\"title\":\"\",\"post\":\"Apoyo\"},\"pt\":{\"title\":\"\",\"post\":\"Apoiar\"}}",
                    "id": "support"
                },
                {
                    "channel_name": "Discussions",
                    "type": "public",
                    "resource_type": "general",
                    "position": 2,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Discussions\"},\"nl\":{\"title\":\"\",\"post\":\"Discussies\"},\"fr\":{\"title\":\"\",\"post\":\"Discussions\"},\"es\":{\"title\":\"\",\"post\":\"Discusiones\"},\"pt\":{\"title\":\"\",\"post\":\"Discussões\"}}",
                    "id": "discussions"
                },
                {
                    "channel_name": "What's new",
                    "type": "private",
                    "resource_type": "multiple",
                    "position": 3,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"What's new\"},\"nl\":{\"title\":\"\",\"post\":\"Wat is er nieuw\"},\"fr\":{\"title\":\"\",\"post\":\"Quoi de neuf\"},\"es\":{\"title\":\"\",\"post\":\"Qué hay de nuevo\"},\"pt\":{\"title\":\"\",\"post\":\"O que há de novo\"}}",
                    "id": "whats-new"
                },
                {
                    "channel_name": "Roadmap",
                    "type": "private",
                    "resource_type": "roadmap",
                    "position": 4,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Roadmap\"},\"nl\":{\"title\":\"\",\"post\":\"Routekaart\"},\"fr\":{\"title\":\"\",\"post\":\"Feuille de route\"},\"es\":{\"title\":\"\",\"post\":\"Hoja de ruta\"},\"pt\":{\"title\":\"\",\"post\":\"Roteiro\"}}",
                    "id": "roadmap"
                },
                {
                    "channel_name": "Feedback",
                    "type": "private",
                    "resource_type": "general",
                    "position": 5,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Feedback\"},\"nl\":{\"title\":\"\",\"post\":\"Feedback\"},\"fr\":{\"title\":\"\",\"post\":\"Retour\"},\"es\":{\"title\":\"\",\"post\":\"Comentario\"},\"pt\":{\"title\":\"\",\"post\":\"Opinião\"}}",
                    "id": "feedback"
                },
                {
                    "channel_name": "Report a bug",
                    "type": "private",
                    "resource_type": "general",
                    "position": 6,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Report a bug\"},\"nl\":{\"title\":\"\",\"post\":\"Meld een bug\"},\"fr\":{\"title\":\"\",\"post\":\"Signaler un bug\"},\"es\":{\"title\":\"\",\"post\":\"Reportar un error\"},\"pt\":{\"title\":\"\",\"post\":\"Reportar um bug\"}}",
                    "id": "report-a-bug"
                },
                {
                    "channel_name": "FAQ's",
                    "type": "public",
                    "resource_type": "multiple",
                    "position": 7,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"FAQ's\"},\"nl\":{\"title\":\"\",\"post\":\"Veelgestelde vragen\"},\"fr\":{\"title\":\"\",\"post\":\"FAQ\"},\"es\":{\"title\":\"\",\"post\":\"Preguntas frecuentes\"},\"pt\":{\"title\":\"\",\"post\":\"Perguntas frequentes\"}}",
                    "id": "faqs"
                }
            ]
        },
        {
            "id": 251,
            "tab_name": "Knowledge hub",
            "type": "public",
            "channels": [
                {
                    "channel_name": "Help center",
                    "type": "public",
                    "resource_type": "knowledge",
                    "position": 1,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Help center\"},\"nl\":{\"title\":\"\",\"post\":\"Helpcentrum\"},\"fr\":{\"title\":\"\",\"post\":\"Centre d'aide\"},\"es\":{\"title\":\"\",\"post\":\"Centro de ayuda\"},\"pt\":{\"title\":\"\",\"post\":\"Central de ajuda\"}}",
                    "id": "help-center"
                },
                {
                    "channel_name": "For developers",
                    "type": "private",
                    "resource_type": "knowledge",
                    "position": 2,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"For developers\"},\"nl\":{\"title\":\"\",\"post\":\"Voor ontwikkelaars\"},\"fr\":{\"title\":\"\",\"post\":\"Pour les développeurs\"},\"es\":{\"title\":\"\",\"post\":\"Para desarrolladores\"},\"pt\":{\"title\":\"\",\"post\":\"Para desenvolvedores\"}}",
                    "id": "for-developers"
                },
                {
                    "channel_name": "Blog",
                    "type": "public",
                    "resource_type": "external",
                    "position": 3,
                    "url": "https://www.useturf.io/blog",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Blog\"},\"nl\":{\"title\":\"\",\"post\":\"Blog\"},\"fr\":{\"title\":\"\",\"post\":\"Blog\"},\"es\":{\"title\":\"\",\"post\":\"Blog\"},\"pt\":{\"title\":\"\",\"post\":\"Blogue\"}}",
                    "id": "blog"
                }
            ]
        },
        {
            "id": 987,
            "tab_name": "Community building",
            "type": "public",
            "channels": [
                {
                    "channel_name": "Discussions",
                    "type": "private",
                    "resource_type": "general",
                    "position": 1,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Discussions\"},\"nl\":{\"title\":\"\",\"post\":\"Discussies\"},\"fr\":{\"title\":\"\",\"post\":\"Discussions\"},\"es\":{\"title\":\"\",\"post\":\"Discusiones\"},\"pt\":{\"title\":\"\",\"post\":\"Discussões\"}}",
                    "id": "discussions-729f0"
                },
                {
                    "channel_name": "Questions",
                    "type": "private",
                    "resource_type": "general",
                    "position": 2,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Questions\"},\"nl\":{\"title\":\"\",\"post\":\"Vragen\"},\"fr\":{\"title\":\"\",\"post\":\"Questions\"},\"es\":{\"title\":\"\",\"post\":\"Preguntas\"},\"pt\":{\"title\":\"\",\"post\":\"Questões\"}}",
                    "id": "questions"
                },
                {
                    "channel_name": "Best practices",
                    "type": "private",
                    "resource_type": "general",
                    "position": 3,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Best practices\"},\"nl\":{\"title\":\"\",\"post\":\"Beste praktijken\"},\"fr\":{\"title\":\"\",\"post\":\"Bonnes pratiques\"},\"es\":{\"title\":\"\",\"post\":\"Mejores prácticas\"},\"pt\":{\"title\":\"\",\"post\":\"Melhores práticas\"}}",
                    "id": "best-practices"
                },
                {
                    "channel_name": "Academy",
                    "type": "private",
                    "resource_type": "knowledge",
                    "position": 4,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Academy\"},\"nl\":{\"title\":\"\",\"post\":\"Academie\"},\"fr\":{\"title\":\"\",\"post\":\"Académie\"},\"es\":{\"title\":\"\",\"post\":\"Academia\"},\"pt\":{\"title\":\"\",\"post\":\"Academia\"}}",
                    "id": "academy"
                },
                {
                    "channel_name": "Courses",
                    "type": "private",
                    "resource_type": "course",
                    "position": 32,
                    "url": "",
                    "translations": null,
                    "id": "courses"
                }
            ]
        },
        {
            "id": 990,
            "tab_name": "Other",
            "type": "public",
            "channels": [
                {
                    "channel_name": "Advisory board",
                    "type": "private",
                    "resource_type": "general",
                    "position": 20,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Advisory board\"},\"nl\":{\"title\":\"\",\"post\":\"Adviesraad\"},\"fr\":{\"title\":\"\",\"post\":\"Conseil consultatif\"},\"es\":{\"title\":\"\",\"post\":\"Consejo asesor\"},\"pt\":{\"title\":\"\",\"post\":\"Conselho consultivo\"}}",
                    "id": "advisory-board"
                },
                {
                    "channel_name": "Partners",
                    "type": "private",
                    "resource_type": "general",
                    "position": 21,
                    "url": "",
                    "translations": "{\"en\":{\"title\":\"\",\"post\":\"Partners\"},\"nl\":{\"title\":\"\",\"post\":\"Partners\"},\"fr\":{\"title\":\"\",\"post\":\"Partenaires\"},\"es\":{\"title\":\"\",\"post\":\"Fogonadura\"},\"pt\":{\"title\":\"\",\"post\":\"Parceiros\"}}",
                    "id": "partners"
                }
            ]
        }
    ]
}
Modified at 2025-09-03 12:04:59
Previous
Get Member's Comments
Next
Create Discussion Post
Built with