Changelogs

Index

This method gets a list of projects changelogs, scheduled, draft and published.

Request

curl --request GET \
  --url https://api.changelogfy.com/v1/posts?page=1 \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "x-project-token: ${YOUR_APP_ID}"

Response

{
  "current_page": 1,
  "data": [
    {
      "id": 1,
      "thumbnail": null,
      "project_id": 1,
      "user_id": 1,
      "published": 1,
      "published_at": "2021-11-13 01:18:30",
      "fixed_on_top": false,
      "override_url": null,
      "expire_at": null,
      "thumbnail_preview": null,
      "labels": [
        {
          "id": 2,
          "name": "Fix",
          "color": "#FF1197",
          "project_id": 1,
          "primary_color": "rgba(255,17,151,1.00)",
          "secondary_color": "rgba(255,17,151,0.12)",
          "pivot": {
            "post_id": 1,
            "label_id": 2,
            "created_at": null,
            "updated_at": null
          }
        }
      ],
      "user": {
        "id": 1,
        "name": "Paulo",
        "avatar": "https://ui-avatars.com/api/?name=Paulo&color=FFFFFF&background=9CA3AF",
        "job": null
      },
      "post_content": {
        "id": 1,
        "title": "Lorem Lorem",
        "body": "<p>Lorem Lorem Lorem Lorem</p>",
        "slug": "lorem-lorem-english-uYc2Rr",
        "post_id": 1,
        "language_id": 1,
        "created_at": "2021-11-13T01:18:40.000000Z",
        "updated_at": "2021-11-13T01:18:40.000000Z",
        "deleted_at": null,
        "language": {
          "id": 1,
          "name": "English",
          "locale": "en",
          "created_at": "2021-11-13T01:09:12.000000Z",
          "updated_at": "2021-11-13T01:09:12.000000Z",
          "flag": "🇺🇸"
        }
      },
      "post_contents": [
        {
          "id": 1,
          "title": "Lorem Lorem",
          "body": "<p>Lorem Lorem Lorem Lorem</p>",
          "slug": "lorem-lorem-english-uYc2Rr",
          "post_id": 1,
          "language_id": 1,
          "created_at": "2021-11-13T01:18:40.000000Z",
          "updated_at": "2021-11-13T01:18:40.000000Z",
          "deleted_at": null,
          "language": {
            "id": 1,
            "name": "English",
            "locale": "en",
            "created_at": "2021-11-13T01:09:12.000000Z",
            "updated_at": "2021-11-13T01:09:12.000000Z",
            "flag": "🇺🇸"
          }
        }
      ]
    },
    {
      "id": 3,
      "thumbnail": null,
      "project_id": 1,
      "user_id": 1,
      "published": 1,
      "published_at": "2021-11-15 14:27:39",
      "fixed_on_top": false,
      "override_url": null,
      "expire_at": null,
      "thumbnail_preview": null,
      "labels": [
        {
          "id": 3,
          "name": "New",
          "color": "#32AD03",
          "project_id": 1,
          "primary_color": "rgba(50,173,3,1.00)",
          "secondary_color": "rgba(50,173,3,0.12)",
          "pivot": {
            "post_id": 3,
            "label_id": 3,
            "created_at": null,
            "updated_at": null
          }
        }
      ],
      "user": {
        "id": 1,
        "name": "Paulo",
        "avatar": "https://ui-avatars.com/api/?name=Paulo&color=FFFFFF&background=9CA3AF",
        "job": null
      },
      "post_content": {
        "id": 3,
        "title": "Changelog in English",
        "body": "<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>",
        "slug": "changelog-in-english-english-lNyZSy",
        "post_id": 3,
        "language_id": 1,
        "created_at": "2021-11-15T14:28:37.000000Z",
        "updated_at": "2021-11-15T14:32:22.000000Z",
        "deleted_at": null,
        "language": {
          "id": 1,
          "name": "English",
          "locale": "en",
          "created_at": "2021-11-13T01:09:12.000000Z",
          "updated_at": "2021-11-13T01:09:12.000000Z",
          "flag": "🇺🇸"
        }
      },
      "post_contents": [
        {
          "id": 3,
          "title": "Changelog in English",
          "body": "<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>",
          "slug": "changelog-in-english-english-lNyZSy",
          "post_id": 3,
          "language_id": 1,
          "created_at": "2021-11-15T14:28:37.000000Z",
          "updated_at": "2021-11-15T14:32:22.000000Z",
          "deleted_at": null,
          "language": {
            "id": 1,
            "name": "English",
            "locale": "en",
            "created_at": "2021-11-13T01:09:12.000000Z",
            "updated_at": "2021-11-13T01:09:12.000000Z",
            "flag": "🇺🇸"
          }
        },
        {
          "id": 4,
          "title": "Changelog in Spanish",
          "body": "<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>",
          "slug": "changelog-in-spanish-spanish-0vkRgC",
          "post_id": 3,
          "language_id": 7,
          "created_at": "2021-11-15T14:28:37.000000Z",
          "updated_at": "2021-11-15T14:32:22.000000Z",
          "deleted_at": null,
          "language": {
            "id": 7,
            "name": "Spanish",
            "locale": "es",
            "created_at": "2021-11-13T01:09:12.000000Z",
            "updated_at": "2021-11-13T01:09:12.000000Z",
            "flag": "🇪🇸"
          }
        },
        {
          "id": 5,
          "title": "Changelog in Portuguese",
          "body": "<p>It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout. The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters, as opposed to using 'Content here, content here', making it look like readable English. Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text, and a search for 'lorem ipsum' will uncover many web sites still in their infancy. Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).</p>",
          "slug": "changelog-in-portuguese-portuguese-k49A9Y",
          "post_id": 3,
          "language_id": 5,
          "created_at": "2021-11-15T14:28:37.000000Z",
          "updated_at": "2021-11-15T14:32:22.000000Z",
          "deleted_at": null,
          "language": {
            "id": 5,
            "name": "Portuguese",
            "locale": "pt_BR",
            "created_at": "2021-11-13T01:09:12.000000Z",
            "updated_at": "2021-11-13T01:09:12.000000Z",
            "flag": "🇧🇷"
          }
        }
      ]
    },
    {
      "id": 4,
      "thumbnail": null,
      "project_id": 1,
      "user_id": 1,
      "published": 1,
      "published_at": "2021-11-16 13:18:21",
      "fixed_on_top": false,
      "override_url": null,
      "expire_at": null,
      "thumbnail_preview": null,
      "labels": [],
      "user": {
        "id": 1,
        "name": "Paulo",
        "avatar": "https://ui-avatars.com/api/?name=Paulo&color=FFFFFF&background=9CA3AF",
        "job": null
      },
      "post_content": {
        "id": 6,
        "title": "asdasdasds",
        "body": "<p>asdasd</p>",
        "slug": "asdasdasds-english-XCYhuN",
        "post_id": 4,
        "language_id": 1,
        "created_at": "2021-11-16T13:18:26.000000Z",
        "updated_at": "2021-11-16T13:18:26.000000Z",
        "deleted_at": null,
        "language": {
          "id": 1,
          "name": "English",
          "locale": "en",
          "created_at": "2021-11-13T01:09:12.000000Z",
          "updated_at": "2021-11-13T01:09:12.000000Z",
          "flag": "🇺🇸"
        }
      },
      "post_contents": [
        {
          "id": 6,
          "title": "asdasdasds",
          "body": "<p>asdasd</p>",
          "slug": "asdasdasds-english-XCYhuN",
          "post_id": 4,
          "language_id": 1,
          "created_at": "2021-11-16T13:18:26.000000Z",
          "updated_at": "2021-11-16T13:18:26.000000Z",
          "deleted_at": null,
          "language": {
            "id": 1,
            "name": "English",
            "locale": "en",
            "created_at": "2021-11-13T01:09:12.000000Z",
            "updated_at": "2021-11-13T01:09:12.000000Z",
            "flag": "🇺🇸"
          }
        }
      ]
    }
  ],
  "first_page_url": "https://api.changelogfy.com/v1/posts?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://api.changelogfy.com/v1/posts?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "https://api.changelogfy.com/v1/posts?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "https://api.changelogfy.com/v1/posts",
  "per_page": 5,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

The changelog structure
One post has many post_contents (languages), but to facilitate life, we ever return post_content too, this is a default content language for post.
One post has many labels.
One post has one user (author).

Updated on: 10/13/2023