Get Project

Get project with specified id.

Get Project

GET https://environment.monterosa.cloud/api/v2/projects/:project_id

Path Parameters

Name	Type	Description
project_id	string	Project ID.

Query Parameters

Name	Type	Description
fields[projects]	string	Comma-separated list of attribute names. When provided, only the listed attributes are returned in the response. Use to opt in to Optional attributes or to reduce payload size.

Optional attributes

The following attributes are not returned by default. To include them, list their names in the fields[projects] query parameter, alongside any other attributes you need.

Attribute	Type	Description
concurrent_users	integer	Number of users currently engaging with the project, fetched in real time.
peak_concurrency	integer	Highest number of concurrent users observed for the project.

The requested attributes appear in the attributes object of the project resource. See Get project with optional attributes for a worked example.

Headers

Name	Type	Description
Authorization	string	Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
Content-Type	string	application/vnd.api+json

200

{
  "data": {
    "id": "aeacad00-2356-4c6b-a923-c2e6c21fbd23",
    "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",
      "image_url": "https://cdn-int.monterosa.cloud/projects/images/30/30f5fd48-550f-4377-81ef-d5552a8afc0b/Property_1_Quick_Poll.png"
    },
    "links": {
      "self": "https://environment.lvis.io/api/v2/projects/aeacad00-2356-4c6b-a923-c2e6c21fbd23"
    },
    "relationships": {
      "events": {
        "links": {
          "related": "https://environment.lvis.io/api/v2/projects/aeacad00-2356-4c6b-a923-c2e6c21fbd23/events"
        }
      },
      "app": {
        "data": {
          "id": "0464bec1-2b27-4899-9909-36dd083dd2b4",
          "type": "apps"
        }
      },
      "space": {
        "data": {
          "id": "b40b57d9-e34d-4794-bcf4-e910b9d283d4",
          "type": "spaces"
        }
      }
    }
  }
}

Example

curl --request GET \
  --url https://environment.monterosa.cloud/api/v2/projects/aeacad00-2356-4c6b-a923-c2e6c21fbd23 \
  --header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
  --header 'Content-Type: application/vnd.api+json'

Get project with optional attributes

cURL

curl --request GET \
  --globoff --url 'https://environment.monterosa.cloud/api/v2/projects/aeacad00-2356-4c6b-a923-c2e6c21fbd23?fields[projects]=name,concurrent_users,peak_concurrency' \
  --header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
  --header 'Content-Type: application/vnd.api+json'

Response

// Status: 200 OK

{
  "data": {
    "id": "aeacad00-2356-4c6b-a923-c2e6c21fbd23",
    "type": "projects",
    "attributes": {
      "name": "Project Name",
      "concurrent_users": 42,
      "peak_concurrency": 128
    },
    "links": {
      "self": "https://environment.lvis.io/api/v2/projects/aeacad00-2356-4c6b-a923-c2e6c21fbd23"
    },
    "relationships": {
      "events": {
        "links": {
          "related": "https://environment.lvis.io/api/v2/projects/aeacad00-2356-4c6b-a923-c2e6c21fbd23/events"
        }
      },
      "app": {
        "data": {
          "id": "0464bec1-2b27-4899-9909-36dd083dd2b4",
          "type": "apps"
        }
      },
      "space": {
        "data": {
          "id": "b40b57d9-e34d-4794-bcf4-e910b9d283d4",
          "type": "spaces"
        }
      }
    }
  }
}