Get Projects

Get list of projects, available to the user.

Get Projects

GET https://environment.monterosa.cloud/api/v2/brands/:brand_id/projects

Path Parameters

NameTypeDescription

brand_id

string

Brand ID.

Query Parameters

NameTypeDescription

fields[projects]

string

Return sparse fieldset including only specified attributes, separated by comma. Should be used to reduce response time and payload size. "concurrent_users" attribute, which is not included by default, can be fetched using this parameter.

Headers

NameTypeDescription

Authorization

string

Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb

Content-Type

string

application/vnd.api+json

{
  "data": [
    {
      "id": "40c0c0ea-2bab-46c2-8743-faca34a1eba0",
      "type": "projects",
      "attributes": {
        "name": "Project Name",
        "locales": [
          {
            "active": true,
            "default": true,
            "key": "en"
          }
        ],
        "certification_enabled": false,
        "settings": [],
        "hidden_elements": [],
        "presence_counter": {
          "enabled": true,
          "supported": true,
          "min_threshold": 10000
        },
        "archived": false,
        "environment": "production"
      },
      "links": {
        "self": "https://environment.lvis.io/api/v2/projects/40c0c0ea-2bab-46c2-8743-faca34a1eba0"
      },
      "relationships": {
        "events": {
          "links": {
            "related": "https://environment.lvis.io/api/v2/projects/40c0c0ea-2bab-46c2-8743-faca34a1eba0/events"
          }
        },
        "app": {
          "data": {
            "id": "0464bec1-2b27-4899-9909-36dd083dd2b4",
            "type": "apps"
          }
        },
        "brand": {
          "data": {
            "id": "b40b57d9-e34d-4794-bcf4-e910b9d283d4",
            "type": "brands"
          }
        }
      }
    },
    {
      "id": "90d1465e-4499-4058-86b4-60b1f1123830",
      "type": "projects",
      "attributes": {
        "name": "Another Project Name",
        "locales": [
          {
            "active": true,
            "default": true,
            "key": "en"
          }
        ],
        "certification_enabled": false,
        "settings": [],
        "hidden_elements": [],
        "presence_counter": {
          "enabled": true,
          "supported": true,
          "min_threshold": 10000
        },
        "archived": true,
        "environment": "staging"
      },
      "links": {
        "self": "https://environment.lvis.io/api/v2/projects/90d1465e-4499-4058-86b4-60b1f1123830"
      },
      "relationships": {
        "events": {
          "links": {
            "related": "https://environment.lvis.io/api/v2/projects/90d1465e-4499-4058-86b4-60b1f1123830/events"
          }
        },
        "app": {
          "data": {
            "id": "0464bec1-2b27-4899-9909-36dd083dd2b4",
            "type": "apps"
          }
        },
        "brand": {
          "data": {
            "id": "b40b57d9-e34d-4794-bcf4-e910b9d283d4",
            "type": "brands"
          }
        }
      }
    }
  ]
}

Example

curl --request GET \
  --url https://environment.monterosa.cloud/api/v2/brands/8630c508-7d12-4e6d-85d5-5e507e97738e/projects \
  --header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
  --header 'Content-Type: application/vnd.api+json'