Loading ...

REST API: Get Idea Stages | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Ideas » REST API: Get Idea Stages
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 3

REST API: Get Idea Stages

0 
 /5
0 (0votes)

Get Idea Stages

GET /api/content/stages

Gets the idea stages of a space. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
SpaceID &SpaceID=x - Used in the request URL as a query parameter

Unique ID for the space.

Example Request

GET https://myintranet.communifire.com/api/content/stages?SpaceID=2

Example Response

Idea stages JSON object is returned as ResponseData.

{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": [
        {
            "StageID": 21,
            "SpaceID": 2,
            "StageName": "Active",
            "SpaceName": "Human Resources",
            "IdeaCount": 4,
            "TenantID": 0
        },
        {
            "StageID": 22,
            "SpaceID": 2,
            "StageName": "Already Offered",
            "SpaceName": "Human Resources",
            "IdeaCount": 2,
            "TenantID": 0
        },
        {
            "StageID": 23,
            "SpaceID": 2,
            "StageName": "Archived",
            "SpaceName": "Human Resources",
            "IdeaCount": 1,
            "TenantID": 0
        },
        {
            "StageID": 24,
            "SpaceID": 2,
            "StageName": "Coming Soon",
            "SpaceName": "Human Resources",
            "IdeaCount": 6,
            "TenantID": 0
        },
        {
            "StageID": 25,
            "SpaceID": 2,
            "StageName": "Delivered",
            "SpaceName": "Human Resources",
            "IdeaCount": 12,
            "TenantID": 0
        },
        {
            "StageID": 26,
            "SpaceID": 2,
            "StageName": "For Future Consideration",
            "SpaceName": "Human Resources",
            "IdeaCount": 5,
            "TenantID": 0
        },
        {
            "StageID": 27,
            "SpaceID": 2,
            "StageName": "In Progress",
            "SpaceName": "Human Resources",
            "IdeaCount": 2,
            "TenantID": 0
        },
        {
            "StageID": 28,
            "SpaceID": 2,
            "StageName": "New",
            "SpaceName": "Human Resources",
            "IdeaCount": 2,
            "TenantID": 0
        },
        {
            "StageID": 29,
            "SpaceID": 2,
            "StageName": "Partially Implemented",
            "SpaceName": "Human Resources",
            "IdeaCount": 0,
            "TenantID": 0
        },
        {
            "StageID": 30,
            "SpaceID": 2,
            "StageName": "Under Review",
            "SpaceName": "Human Resources",
            "IdeaCount": 3,
            "TenantID": 0
        }
    ]
}

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software