Workspace

Get workspace configuration

GET/api/v1/workspace

The workspace's name plus every configured value other operations accept: ticket statuses and priorities, task statuses and types, contact lifecycle stages, feedback statuses, custom field definitions per record type, teams, and deal pipelines with their stages. Call this first so you pass values the workspace actually uses.

Statuses and priorities are passed to other operations by value (for example todo, not To do), though most operations also accept the label.

Custom fields are per record type. A key that is not listed here is rejected with 422 wherever fields are accepted.

Example request

curl "https://crowdstack.org/api/v1/workspace" \
  -H "Authorization: Bearer $CROWDSTACK_API_KEY"

Example response

{
  "organization": {
    "id": "cmf3k2x9a0000abcd",
    "name": "Acme",
    "slug": "acme"
  },
  "tickets": {
    "statuses": [
      {
        "value": "open",
        "label": "Open"
      },
      {
        "value": "pending",
        "label": "Pending"
      },
      {
        "value": "solved",
        "label": "Solved"
      },
      {
        "value": "closed",
        "label": "Closed"
      }
    ],
    "priorities": [
      {
        "value": "low",
        "label": "Low"
      },
      {
        "value": "normal",
        "label": "Normal"
      },
      {
        "value": "high",
        "label": "High"
      }
    ],
    "defaultStatus": "open",
    "defaultPriority": "normal",
    "suggestedTags": [
      "billing",
      "bug"
    ],
    "fields": [
      {
        "key": "plan",
        "label": "Plan",
        "type": "select",
        "options": [
          {
            "value": "starter",
            "label": "Starter"
          }
        ]
      }
    ]
  },
  "tasks": {
    "statuses": [
      {
        "value": "todo",
        "label": "To do"
      },
      {
        "value": "doing",
        "label": "Doing"
      },
      {
        "value": "done",
        "label": "Done"
      }
    ],
    "defaultStatus": "todo",
    "doneStatus": "done",
    "types": [
      {
        "value": "bug",
        "label": "Bug"
      }
    ],
    "defaultType": null,
    "fields": []
  },
  "crm": {
    "lifecycleStages": [
      {
        "value": "lead",
        "label": "Lead"
      },
      {
        "value": "customer",
        "label": "Customer"
      }
    ],
    "contactFields": [],
    "companyFields": [],
    "dealFields": [],
    "suggestedContactTags": [],
    "suggestedCompanyTags": []
  },
  "feedback": {
    "statuses": [
      {
        "value": "under_review",
        "label": "Under review"
      }
    ],
    "defaultStatus": "under_review",
    "areas": []
  },
  "teams": [
    {
      "id": "cmf3k2x9a0050abcd",
      "name": "Support"
    }
  ],
  "pipelines": [
    {
      "id": "cmf3k2x9a0060abcd",
      "name": "Sales",
      "stages": [
        {
          "id": "cmf3k2x9a0061abcd",
          "name": "Qualified",
          "position": 0,
          "isWon": false,
          "isLost": false
        }
      ]
    }
  ]
}