Get paginated posts

curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/posts \
  --header 'x-api-token: <api-key>'

{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "details": {
        "title": "<string>",
        "description": "<string>",
        "light": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        },
        "dark": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        }
      },
      "likes": [
        "<string>"
      ],
      "disableComments": true,
      "disableLikes": true,
      "displayBannerOnPost": true,
      "status": "archived",
      "tags": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "value": "<string>",
          "config": {
            "filtering": [
              "achievement"
            ],
            "display": [
              "achievement"
            ],
            "iconifyIcon": "<string>"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "campaigns": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "name": "<string>",
          "startDate": "<string>",
          "endDate": "<string>",
          "status": "archived",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "availableAsTemplateForOrganisations": [
        "<string>"
      ],
      "isGlobalTemplate": true,
      "createdAt": "<string>",
      "createdBy": "<string>",
      "totalComments": 123,
      "totalLikes": 123,
      "content": "<string>",
      "startsAt": "<string>",
      "expiresAt": "<string>",
      "featured": true,
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    }
  ]
}

Posts

Get paginated posts

Retrieve a paginated list of posts.

Supported query parameters:

limit: number (1-100, default: 10) - Number of items per page
skip: number (>= 0, default: 0) - Number of items to skip
communityId: string - Filter by community ID
status: string - Filter by post status(es). Multiple statuses can be provided as comma-separated values
- Supported values: live, expired
featured: boolean - Filter featured posts
search: string - Search posts by name
sort: string - Sort posts by field and direction
- Supported values: name:asc, name:desc, createdAt:asc, createdAt:desc
- Default: createdAt:desc

GET

posts

Get paginated posts

curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/posts \
  --header 'x-api-token: <api-key>'

{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "details": {
        "title": "<string>",
        "description": "<string>",
        "light": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        },
        "dark": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        }
      },
      "likes": [
        "<string>"
      ],
      "disableComments": true,
      "disableLikes": true,
      "displayBannerOnPost": true,
      "status": "archived",
      "tags": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "value": "<string>",
          "config": {
            "filtering": [
              "achievement"
            ],
            "display": [
              "achievement"
            ],
            "iconifyIcon": "<string>"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "campaigns": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "name": "<string>",
          "startDate": "<string>",
          "endDate": "<string>",
          "status": "archived",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "availableAsTemplateForOrganisations": [
        "<string>"
      ],
      "isGlobalTemplate": true,
      "createdAt": "<string>",
      "createdBy": "<string>",
      "totalComments": 123,
      "totalLikes": 123,
      "content": "<string>",
      "startsAt": "<string>",
      "expiresAt": "<string>",
      "featured": true,
      "updatedAt": "<string>",
      "updatedBy": "<string>"
    }
  ]
}

Authorizations

x-api-token

string

header

required

Headers

x-language

string

The language to return the posts in. If not provided, the default language for the organisation will be used.

Query Parameters

limit

integer

default:10

Required range: 1 <= x <= 100

skip

integer

default:0

Required range: x >= 0

sort

string

communityId

string

allocationId

string

featured

boolean

verified

boolean

isShop

boolean

type

string

status

string

eventCategory

string

eventSubCategory

string

eventName

string

displayMode

string

fromDate

string

toDate

string

isGlobalTemplate

boolean

key

string

progressPeriod

string

Response

Successful response

totalCount

number

required

edges

Post · object[]

required

Show child attributes

edges.id

string

required

The id of the post

edges.organisationId

string

required

The organisation that the post belongs to

edges.communityId

string

required

The community that the post belongs to

edges.details

Details · object

required

The details of this post such as title, description, bannerUrl, logoUrl

Show child attributes

edges.details.title

string

required

The title of the entity

edges.details.description

string | null

required

The description of the entity

edges.details.light

object

required

Light theme images

Show child attributes

edges.details.light.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.details.light.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.details.dark

object

required

Dark theme images

Show child attributes

edges.details.dark.primaryImageUrl

string | null

required

The url of the primary image for this theme mode

edges.details.dark.secondaryImageUrl

string | null

required

The url of the secondary image for this theme mode

edges.likes

string[]

required

Array of user IDs who liked this post

edges.disableComments

boolean

required

Whether comments are disabled on this post. Defaults to false.

edges.disableLikes

boolean

required

Whether likes are disabled on this post. Defaults to false.

edges.displayBannerOnPost

boolean

required

Whether to display a banner on this post. Defaults to false.

edges.status

enum<string>

required

The status of the post

Available options:

archived,

draft,

expired,

live,

scheduled

edges.tags

Tag · object[]

required

The tags the post is linked to

Show child attributes

edges.tags.id

string

required

The id of the tag

edges.tags.organisationId

string

required

The id of the organisation the tag belongs to

edges.tags.value

string

required

The value of the tag

Minimum string length: 1

edges.tags.config

TagConfig · object

required

The configuration of a tag

Show child attributes

edges.tags.config.filtering

enum<string>[]

required

The filtering options for the tag

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

edges.tags.config.display

enum<string>[]

required

The display options for the tag

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

edges.tags.config.iconifyIcon

string | null

The iconify icon for the tag

edges.tags.createdAt

string

required

The date the tag was created

edges.tags.updatedAt

string

required

The date the tag was last updated

edges.campaigns

Campaign · object[]

required

The campaigns the post is linked to

Show child attributes

edges.campaigns.id

string

required

The id of the campaign

edges.campaigns.organisationId

string

required

The id of the organisation the campaign belongs to

edges.campaigns.name

string

required

The name of the campaign

edges.campaigns.startDate

string

required

The start date of the campaign

edges.campaigns.endDate

string

required

The end date of the campaign

edges.campaigns.status

enum<string>

required

The status of the campaign

Available options:

archived,

draft,

expired,

live,

scheduled

edges.campaigns.createdAt

string

required

The date the campaign was created

edges.campaigns.updatedAt

string

required

The date the campaign was last updated

edges.availableAsTemplateForOrganisations

string[]

required

The organisations that the post is available as a template for

edges.isGlobalTemplate

boolean

required

Whether the post is a global template

edges.createdAt

string

required

The date when this post was created

edges.createdBy

string

required

The user who created this post

edges.totalComments

number

required

The total number of comments on this post

edges.totalLikes

number

required

The total number of likes on this post

edges.content

string | null

The content of the post in HTML. Example:

Welcome to Your New Post

This is a placeholder post to demonstrate the capabilities of the editor. Feel free to explore and edit this content to see what you can do!

Basic Formatting

You can use bold, italic, underline, and ~~strikethrough~~ text to emphasize your content.

Lists

You can create a bullet list:

Item 1
Item 2
Item 3

Or a numberered list:

First Item
Second Item
Third Item

Links

You can also add links to your content. For example, visit Example.com for more information.

Images

Including images is simple. Here is an example image:

Blockquotes

You can use blockquotes to highlight important quotes or information:

"This is a sample blockquote. It's great for highlighting quotes or important information in your post."

Feel free to edit this content and explore the various features of the editor. Happy posting!

edges.startsAt

string | null

The date when this post becomes visible.

edges.expiresAt

string | null

The date when this post expires.

edges.featured

boolean | null

edges.updatedAt

string | null

The date when this post was updated

edges.updatedBy

string | null

The user who last updated this post

Unlike a post Get post by id

⌘I

Achievements

Action Participations

Actions

Auth Config

Campaigns

Challenge Groups

Challenges

Comments

Communities

Events

Feature Flags

Languages

Leaderboards

Legal Policies

Me

Posts

Rewards

Tags

Themes

Third Party Config

Variables

Get paginated posts

Authorizations

Headers

Query Parameters

Response

Welcome to Your New Post

Basic Formatting

Lists

Links

Images

Blockquotes