Index

This method get a list of projects you belongs to

Request

curl --request GET \
  --url https://changelogfy.com/api/v1/projects \
  --header 'Accept: application/json' \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Content-Type: application/json'

Response

[
  {
    "id": 3434,
    "name": "Acme",
    "subdomain": "acme",
    "domain": "changelog.acme.com",
    "logo": null,
    "favicon": null,
    "accent_color": "#8b54f3",
    "language_id": 1,
    "website": "https://acme.com",
    "app_id": "c136317g-e4f2-3afc-14cd-bc1af6502c22",
    "changelog_reactions": false,
    "changelog_comments": false
  }
]

Show

This method show details of any project you belongs to

Request

curl --request GET \
  --url https://changelogfy.com/api/v1/projects/{APP_ID} \
  --header 'Accept: application/json' \
  --header "Authorization: Bearer ${TOKEN}" \
  --header 'Content-Type: application/json'

Response

{
  "id": 2,
  "name": "Acme",
  "subdomain": "acme",
  "domain": "changelog.acme.com",
  "logo": null,
  "favicon": null,
  "accent_color": "#8b54f3",
  "language_id": 1,
  "website": "https://acme.com",
  "app_id": "c136317g-e4f2-3afc-14cd-bc1af6502c22",
  "changelog_reactions": false,
  "changelog_comments": false,
  "plan": "free",
  "primary_domain": "https://changelog.acme.com",
  "labels": [
    {
      "id": 4,
      "name": "Improvement",
      "color": "#7300FF",
      "project_id": 2,
      "primary_color": "rgba(115,0,255,1.00)",
      "secondary_color": "rgba(115,0,255,0.12)"
    },
    {
      "id": 5,
      "name": "Fix",
      "color": "#FF1197",
      "project_id": 2,
      "primary_color": "rgba(255,17,151,1.00)",
      "secondary_color": "rgba(255,17,151,0.12)"
    },
    {
      "id": 6,
      "name": "New",
      "color": "#32AD03",
      "project_id": 2,
      "primary_color": "rgba(50,173,3,1.00)",
      "secondary_color": "rgba(50,173,3,0.12)"
    }
  ],
  "languages": [
    {
      "id": 1,
      "name": "English",
      "locale": "en",
      "flag": "🇺🇸",
      "pivot": {
        "project_id": 2,
        "language_id": 1,
        "is_default": 1,
        "created_at": "2021-11-15T13:25:41.000000Z",
        "updated_at": "2021-11-15T13:25:41.000000Z"
      }
    }
  ],
  "default_language": {
    "id": 1,
    "name": "English",
    "locale": "en",
    "flag": "🇺🇸"
  },
  "public_feed_setting": {
    "id": 2,
    "title": "See what’s new at Acme",
    "description": "Check out the latest updates to our products below",
    "website": "https://acme.com",
    "allow_subscribers": false,
    "allow_search_engine_index": false,
    "private": false,
    "custom_css": null,
    "custom_javascript": null,
    "project_id": 2,
    "created_at": "2021-11-15T13:25:41.000000Z",
    "updated_at": "2021-11-15T13:25:41.000000Z",
    "deleted_at": null
  }
}

👉 If you don't know your app_id, click here.
If you still have questions, please contact us by chat.

Updated on: 03/31/2022