Profiles | Venue Docs

Home

get

Authorizations

Path parameters

siteKeystringrequired

Query parameters

limitnumber | nullableoptional

pagenumber | nullableoptional

orderBystringoptional

dirstring · enumoptionalAvailable options:

typestring · enumoptionalAvailable options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://app.venuecms.com/api/v2/{siteKey}/public/profiles' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "records": [
    {
      "siteId": "text",
      "slug": "text",
      "image": {
        "siteId": "text",
        "uploaded": true,
        "inline": true,
        "url": "text",
        "mimeType": "text",
        "size": 1,
        "metadata": {},
        "title": "text",
        "caption": "text",
        "credit": "text",
        "altText": "text"
      },
      "localizedContent": [
        {
          "siteId": "text",
          "locale": "text",
          "title": "text",
          "content": "text",
          "shortContent": "text",
          "extraContent": "text",
          "excerpt": "text",
          "metaTitle": "text",
          "metaDescription": "text",
          "keywords": "text",
          "contentJSON": {}
        }
      ]
    }
  ],
  "count": 1
}

Retrieve a list of Profiles

get