Skip to main content
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,
      "tags": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "value": "<string>",
          "config": {
            "filtering": [],
            "display": [],
            "iconifyIcon": "<string>"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "campaigns": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "name": "<string>",
          "startDate": "<string>",
          "endDate": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "availableAsTemplateForOrganisations": [
        "<string>"
      ],
      "isGlobalTemplate": true,
      "createdAt": "<string>",
      "createdBy": "<string>",
      "community": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "descriptionConfig": {
          "content": "<string>",
          "disableLineClamp": true,
          "maxLines": 5.5
        },
        "logo": "<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
​
search
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
​
expand
string
​
redeemableType
string

Response

Successful response

​
totalCount
number
required
​
edges
Post · object[]
required