API reference

Issue spaces

Spaces, their settings, versions (releases) and components.

Read the Guide

GET/v1/orgs/:orgId/issues/spaces

Spaces the caller can browse (archived=1 includes archived ones).

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:read

Get an API key

Path parameters

orgId
Organization id (org_…).

Query parameters

archived"0" | "1"

curl 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  spaces: {
    orgId: string
    spaceId: string
    key: string
    name: string
    description: string
    template: "basic" | "service" | "scrum" | "kanban" | "bugs"
    leadId?: string
    icon?: string
    color?: string
    archived: boolean
    archivedAt?: number
    seq: number
    config: {
      issueTypeIds: string[]
      defaultTypeId: string
      workflows: {
        [key: string]: string
      }
      screens: {
        create: {
          [key: string]: string
        }
        edit: {
          [key: string]: string
        }
        view: {
          [key: string]: string
        }
      }
      fieldSettings: {
        [key: string]: {
          required?: boolean
          hidden?: boolean
          description?: string
        }
      }
      customFieldIds: string[]
      access: {
        visibility: "org" | "private"
        members: {
          type: "user" | "team"
          id: string
          role: "admin" | "viewer" | "member"
        }[]
      }
      permissionSchemeId?: string
      securityLevels: {
        id: string
        name: string
        description?: string
        grants: object[]
      }[]
      defaultSecurityLevelId?: string
      notifications: {
        approval?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        resolved?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        deleted?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        mentioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        created?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        assigned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        updated?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        transitioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        commented?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
      }
      defaultAssignee: "lead" | "unassigned"
      estimation: "count" | "storyPoints" | "originalEstimate"
      boardId?: string
      servicedesk?: {
        requestTypes: {
          id: string
          name: string
          description?: string
          icon?: string
          typeId: string
          group?: string
          fields: object
          hidden?: boolean
          approval?: object
        }[]
        queues: {
          id: string
          name: string
          query: string
          columns?: object
        }[]
        slas: {
          id: string
          name: string
          start: object
          pause: object
          stop: object
          goals: object
        }[]
        hours: {
          timeZone: string
          days: {
            [key: number]: object
          }
          holidays: string[]
        }
        portal: {
          enabled: boolean
          title: string
          intro: string
          access: "any" | "org" | "listed"
          customers: string[]
        }
        cannedResponses: {
          id: string
          name: string
          body: string
        }[]
        satisfaction: boolean
        email?: {
          mailboxId: string
          address: string
          requestTypeId: string
        }
        articles?: {
          rootPageId: string
        }
      }
      formerKeys?: string[]
    }
    version: number
    createdAt: number
    updatedAt: number
  }[]
}

POST/v1/orgs/:orgId/issues/spaces

Creates a space from a template (scrum, kanban, bugs, service, basic) with its board; the caller becomes lead.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).

Request body

keystringrequired
2–10 characters. Trimmed.
namestringrequired
1–80 characters. Trimmed.
template"scrum" | "kanban" | "bugs" | "service" | "basic"required
descriptionstring
Up to 2,000 characters.
leadIdstring
Up to 64 characters.
iconstring
Up to 16 characters.
color"gray" | "blue" | "green" | "teal" | "yellow" | "orange" | "red" | "pink" | "purple"

curl -X POST 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "example",
    "name": "Example",
    "template": "scrum"
  }'

Send it from this page with your session or a key.

Response 201

{
  space: {
    orgId: string
    spaceId: string
    key: string
    name: string
    description: string
    template: "basic" | "service" | "scrum" | "kanban" | "bugs"
    leadId?: string
    icon?: string
    color?: string
    archived: boolean
    archivedAt?: number
    seq: number
    config: {
      issueTypeIds: string[]
      defaultTypeId: string
      workflows: {
        [key: string]: string
      }
      screens: {
        create: {
          [key: string]: string
        }
        edit: {
          [key: string]: string
        }
        view: {
          [key: string]: string
        }
      }
      fieldSettings: {
        [key: string]: {
          required?: boolean
          hidden?: boolean
          description?: string
        }
      }
      customFieldIds: string[]
      access: {
        visibility: "org" | "private"
        members: {
          type: "user" | "team"
          id: string
          role: "admin" | "viewer" | "member"
        }[]
      }
      permissionSchemeId?: string
      securityLevels: {
        id: string
        name: string
        description?: string
        grants: {
          type: "spaceRole"
          role: "admin" | "viewer" | "member"
        } | {
          type: "orgRole"
          role: string
        } | {
          type: "user"
          id: string
        } | {
          type: "team"
          id: string
        } | {
          type: "reporter"
        } | {
          type: "assignee"
        } | {
          type: "lead"
        } | {
          type: "anyone"
        }[]
      }[]
      defaultSecurityLevelId?: string
      notifications: {
        approval?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        resolved?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        deleted?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        mentioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        created?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        assigned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        updated?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        transitioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        commented?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
      }
      defaultAssignee: "lead" | "unassigned"
      estimation: "count" | "storyPoints" | "originalEstimate"
      boardId?: string
      servicedesk?: {
        requestTypes: {
          id: string
          name: string
          description?: string
          icon?: string
          typeId: string
          group?: string
          fields: string[]
          hidden?: boolean
          approval?: {
            statusId: string
            approvers: object
            needed: "all" | "one"
            approvedStatusId: string
            declinedStatusId: string
          }
        }[]
        queues: {
          id: string
          name: string
          query: string
          columns?: string[]
        }[]
        slas: {
          id: string
          name: string
          start: string[]
          pause: string[]
          stop: string[]
          goals: object[]
        }[]
        hours: {
          timeZone: string
          days: {
            [key: number]: object[]
          }
          holidays: string[]
        }
        portal: {
          enabled: boolean
          title: string
          intro: string
          access: "any" | "org" | "listed"
          customers: string[]
        }
        cannedResponses: {
          id: string
          name: string
          body: string
        }[]
        satisfaction: boolean
        email?: {
          mailboxId: string
          address: string
          requestTypeId: string
        }
        articles?: {
          rootPageId: string
        }
      }
      formerKeys?: string[]
    }
    version: number
    createdAt: number
    updatedAt: number
  }
}

GET/v1/orgs/:orgId/issues/spaces/:spaceKey

A space with what the caller may do in it, its versions and components.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:read

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

curl 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  space: {
    orgId: string
    spaceId: string
    key: string
    name: string
    description: string
    template: "basic" | "service" | "scrum" | "kanban" | "bugs"
    leadId?: string
    icon?: string
    color?: string
    archived: boolean
    archivedAt?: number
    seq: number
    config: {
      issueTypeIds: string[]
      defaultTypeId: string
      workflows: {
        [key: string]: string
      }
      screens: {
        create: {
          [key: string]: string
        }
        edit: {
          [key: string]: string
        }
        view: {
          [key: string]: string
        }
      }
      fieldSettings: {
        [key: string]: {
          required?: boolean
          hidden?: boolean
          description?: string
        }
      }
      customFieldIds: string[]
      access: {
        visibility: "org" | "private"
        members: {
          type: "user" | "team"
          id: string
          role: "admin" | "viewer" | "member"
        }[]
      }
      permissionSchemeId?: string
      securityLevels: {
        id: string
        name: string
        description?: string
        grants: {
          type: "spaceRole"
          role: "admin" | "viewer" | "member"
        } | {
          type: "orgRole"
          role: string
        } | {
          type: "user"
          id: string
        } | {
          type: "team"
          id: string
        } | {
          type: "reporter"
        } | {
          type: "assignee"
        } | {
          type: "lead"
        } | {
          type: "anyone"
        }[]
      }[]
      defaultSecurityLevelId?: string
      notifications: {
        approval?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        resolved?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        deleted?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        mentioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        created?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        assigned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        updated?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        transitioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        commented?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
      }
      defaultAssignee: "lead" | "unassigned"
      estimation: "count" | "storyPoints" | "originalEstimate"
      boardId?: string
      servicedesk?: {
        requestTypes: {
          id: string
          name: string
          description?: string
          icon?: string
          typeId: string
          group?: string
          fields: string[]
          hidden?: boolean
          approval?: {
            statusId: string
            approvers: object
            needed: "all" | "one"
            approvedStatusId: string
            declinedStatusId: string
          }
        }[]
        queues: {
          id: string
          name: string
          query: string
          columns?: string[]
        }[]
        slas: {
          id: string
          name: string
          start: string[]
          pause: string[]
          stop: string[]
          goals: object[]
        }[]
        hours: {
          timeZone: string
          days: {
            [key: number]: object[]
          }
          holidays: string[]
        }
        portal: {
          enabled: boolean
          title: string
          intro: string
          access: "any" | "org" | "listed"
          customers: string[]
        }
        cannedResponses: {
          id: string
          name: string
          body: string
        }[]
        satisfaction: boolean
        email?: {
          mailboxId: string
          address: string
          requestTypeId: string
        }
        articles?: {
          rootPageId: string
        }
      }
      formerKeys?: string[]
    }
    version: number
    createdAt: number
    updatedAt: number
  }
  permissions: {
    link?: boolean
    move?: boolean
    edit?: boolean
    comment?: boolean
    worklog?: boolean
    delete?: boolean
    create?: boolean
    browse?: boolean
    editOwn?: boolean
    transition?: boolean
    assign?: boolean
    assignable?: boolean
    deleteOwn?: boolean
    editComments?: boolean
    deleteComments?: boolean
    attach?: boolean
    deleteAttachments?: boolean
    manageWatchers?: boolean
    manageSprints?: boolean
    administer?: boolean
    serviceAgent?: boolean
  }
  allPermissions: ["browse", "create", "edit", "editOwn", "transition", "assign", "assignable", "delete", "deleteOwn", "comment", "editComments", "deleteComments", "attach", "deleteAttachments", "link", "worklog", "manageWatchers", "manageSprints", "move", "administer", "serviceAgent"]
  versions: {
    versionId: string
    spaceId: string
    name: string
    description: string
    startDate?: string
    releaseDate?: string
    released: boolean
    releasedAt?: number
    archived: boolean
    position: number
    data: {
      deployments?: {
        deploymentId: string
        projectId: string
        label?: string
        at: number
      }[]
    }
  }[]
  components: {
    componentId: string
    spaceId: string
    name: string
    description: string
    leadId?: string
    defaultAssignee: "space" | "lead" | "unassigned"
  }[]
}

PATCH/v1/orgs/:orgId/issues/spaces/:spaceKey

Changes a space: name, key (old keys keep resolving), lead, and its configuration (types, workflows, screens, fields, access, security levels, notifications, service desk).

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

Request body

namestring
1–80 characters. Trimmed.
keystring
2–10 characters. Trimmed.
descriptionstring
Up to 2,000 characters.
leadIdstring
Up to 64 characters.
iconstring
Up to 16 characters.
color"gray" | "blue" | "green" | "teal" | "yellow" | "orange" | "red" | "pink" | "purple"
configobject
config.issueTypeIdsstring[]
Up to 50 items. Each up to 32 characters.
config.defaultTypeIdstring
Up to 32 characters.
config.workflowsobject
Keys up to 32 characters. Values: string (up to 64 characters).
config.screensobject
config.screens.createobjectrequired
Values: string (up to 64 characters).
config.screens.editobjectrequired
Values: string (up to 64 characters).
config.screens.viewobjectrequired
Values: string (up to 64 characters).
config.fieldSettingsobject
Keys up to 64 characters. Values: object.
config.customFieldIdsstring[]
Up to 200 items. Each up to 64 characters.
config.accessobject
config.access.visibility"org" | "private"required
config.access.membersobject[]required
Up to 500 items.
config.access.members[].type"user" | "team"required
config.access.members[].idstringrequired
Up to 64 characters.
config.access.members[].role"admin" | "member" | "viewer"required
config.permissionSchemeIdstring
Up to 64 characters.
config.securityLevelsobject[]
Up to 20 items.
config.securityLevels[].idstringrequired
Up to 40 characters.
config.securityLevels[].namestringrequired
1–80 characters. Trimmed.
config.securityLevels[].descriptionstring
Up to 500 characters.
config.securityLevels[].grantsobject[]required
Up to 50 items.
config.securityLevels[].grants[].typestringrequired
Up to 20 characters.
config.securityLevels[].grants[].rolestring
Up to 20 characters.
config.securityLevels[].grants[].idstring
Up to 64 characters.
config.defaultSecurityLevelIdstring
Up to 40 characters.
config.notificationsobject
Values: ("assignee" | "reporter" | "watchers" | "lead" | "participants")[].
config.defaultAssignee"unassigned" | "lead"
config.estimation"storyPoints" | "originalEstimate" | "count"
config.servicedeskobject
config.servicedesk.requestTypesobject[]required
Up to 100 items.
config.servicedesk.requestTypes[].idstringrequired
Up to 40 characters.
config.servicedesk.requestTypes[].namestringrequired
1–80 characters. Trimmed.
config.servicedesk.requestTypes[].descriptionstring
Up to 500 characters.
config.servicedesk.requestTypes[].iconstring
Up to 40 characters.
config.servicedesk.requestTypes[].typeIdstringrequired
Up to 32 characters.
config.servicedesk.requestTypes[].groupstring
Up to 60 characters.
config.servicedesk.requestTypes[].fieldsstring[]required
Up to 30 items. Each up to 64 characters.
config.servicedesk.requestTypes[].hiddenboolean
config.servicedesk.requestTypes[].approvalobject
config.servicedesk.requestTypes[].approval.statusIdstringrequired
Up to 32 characters.
config.servicedesk.requestTypes[].approval.approversstring[]required
Up to 20 items. Each up to 64 characters.
config.servicedesk.requestTypes[].approval.needed"one" | "all"required
config.servicedesk.requestTypes[].approval.approvedStatusIdstringrequired
Up to 32 characters.
config.servicedesk.requestTypes[].approval.declinedStatusIdstringrequired
Up to 32 characters.
config.servicedesk.queuesobject[]required
Up to 50 items.
config.servicedesk.queues[].idstringrequired
Up to 40 characters.
config.servicedesk.queues[].namestringrequired
1–80 characters. Trimmed.
config.servicedesk.queues[].querystringrequired
Up to 2,000 characters.
config.servicedesk.queues[].columnsstring[]
Up to 20 items. Each up to 64 characters.
config.servicedesk.slasobject[]required
Up to 20 items.
config.servicedesk.slas[].idstringrequired
Up to 40 characters.
config.servicedesk.slas[].namestringrequired
1–80 characters. Trimmed.
config.servicedesk.slas[].startstring[]required
Up to 20 items. Each up to 80 characters.
config.servicedesk.slas[].pausestring[]required
Up to 20 items. Each up to 80 characters.
config.servicedesk.slas[].stopstring[]required
Up to 20 items. Each up to 80 characters.
config.servicedesk.slas[].goalsobject[]required
Up to 20 items.
config.servicedesk.slas[].goals[].querystring
Up to 2,000 characters.
config.servicedesk.slas[].goals[].minutesintegerrequired
1–525600.
config.servicedesk.slas[].goals[].calendar"business" | "always"
config.servicedesk.hoursobjectrequired
config.servicedesk.hours.timeZonestringrequired
Up to 64 characters.
config.servicedesk.hours.daysobjectrequired
Values: integer[][] (up to 4 items, each 2 items, each 0–1440).
config.servicedesk.hours.holidaysstring[]required
Up to 200 items. Each matches ^\d{4}-\d{2}-\d{2}$.
config.servicedesk.portalobjectrequired
config.servicedesk.portal.enabledbooleanrequired
config.servicedesk.portal.titlestringrequired
Up to 100 characters.
config.servicedesk.portal.introstringrequired
Up to 2,000 characters.
config.servicedesk.portal.access"org" | "listed" | "any"required
config.servicedesk.portal.customersstring[]required
Up to 5,000 items. Each up to 320 characters.
config.servicedesk.cannedResponsesobject[]required
Up to 100 items.
config.servicedesk.cannedResponses[].idstringrequired
Up to 40 characters.
config.servicedesk.cannedResponses[].namestringrequired
Up to 80 characters.
config.servicedesk.cannedResponses[].bodystringrequired
Up to 8,000 characters.
config.servicedesk.satisfactionbooleanrequired
config.servicedesk.articlesobject
config.servicedesk.articles.rootPageIdstringrequired
Up to 64 characters.
baseVersioninteger
≥ 0.

curl -X PATCH 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example",
    "key": "example",
    "description": "example"
  }'

Send it from this page with your session or a key.

Response 200

{
  space: {
    orgId: string
    spaceId: string
    key: string
    name: string
    description: string
    template: "basic" | "service" | "scrum" | "kanban" | "bugs"
    leadId?: string
    icon?: string
    color?: string
    archived: boolean
    archivedAt?: number
    seq: number
    config: {
      issueTypeIds: string[]
      defaultTypeId: string
      workflows: {
        [key: string]: string
      }
      screens: {
        create: {
          [key: string]: string
        }
        edit: {
          [key: string]: string
        }
        view: {
          [key: string]: string
        }
      }
      fieldSettings: {
        [key: string]: {
          required?: boolean
          hidden?: boolean
          description?: string
        }
      }
      customFieldIds: string[]
      access: {
        visibility: "org" | "private"
        members: {
          type: "user" | "team"
          id: string
          role: "admin" | "viewer" | "member"
        }[]
      }
      permissionSchemeId?: string
      securityLevels: {
        id: string
        name: string
        description?: string
        grants: {
          type: "spaceRole"
          role: "admin" | "viewer" | "member"
        } | {
          type: "orgRole"
          role: string
        } | {
          type: "user"
          id: string
        } | {
          type: "team"
          id: string
        } | {
          type: "reporter"
        } | {
          type: "assignee"
        } | {
          type: "lead"
        } | {
          type: "anyone"
        }[]
      }[]
      defaultSecurityLevelId?: string
      notifications: {
        approval?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        resolved?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        deleted?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        mentioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        created?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        assigned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        updated?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        transitioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        commented?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
      }
      defaultAssignee: "lead" | "unassigned"
      estimation: "count" | "storyPoints" | "originalEstimate"
      boardId?: string
      servicedesk?: {
        requestTypes: {
          id: string
          name: string
          description?: string
          icon?: string
          typeId: string
          group?: string
          fields: string[]
          hidden?: boolean
          approval?: {
            statusId: string
            approvers: object
            needed: "all" | "one"
            approvedStatusId: string
            declinedStatusId: string
          }
        }[]
        queues: {
          id: string
          name: string
          query: string
          columns?: string[]
        }[]
        slas: {
          id: string
          name: string
          start: string[]
          pause: string[]
          stop: string[]
          goals: object[]
        }[]
        hours: {
          timeZone: string
          days: {
            [key: number]: object[]
          }
          holidays: string[]
        }
        portal: {
          enabled: boolean
          title: string
          intro: string
          access: "any" | "org" | "listed"
          customers: string[]
        }
        cannedResponses: {
          id: string
          name: string
          body: string
        }[]
        satisfaction: boolean
        email?: {
          mailboxId: string
          address: string
          requestTypeId: string
        }
        articles?: {
          rootPageId: string
        }
      }
      formerKeys?: string[]
    }
    version: number
    createdAt: number
    updatedAt: number
  }
}

PUT/v1/orgs/:orgId/issues/spaces/:spaceKey/email

Requests by email: links one of the org's Mail mailboxes to a service space (mailboxId null unlinks). New mail raises a request of requestTypeId; replies with [KEY-n] in the subject become comments. Needs the space's administer permission and the mailbox (as a member, or mail:admin).

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

Request body

mailboxIdstringrequiredor null
Up to 64 characters.
requestTypeIdstring
Up to 40 characters.

curl -X PUT 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/email' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "mailboxId": "<mailboxId>"
  }'

Send it from this page with your session or a key.

Response 200

{
  email: null | {
    mailboxId: string
    address: string
    requestTypeId: string
  }
}

POST/v1/orgs/:orgId/issues/spaces/:spaceKey/archive

Archives a space: read-only and hidden from lists.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

curl -X POST 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/archive' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  space: {
    orgId: string
    spaceId: string
    key: string
    name: string
    description: string
    template: "basic" | "service" | "scrum" | "kanban" | "bugs"
    leadId?: string
    icon?: string
    color?: string
    archived: boolean
    archivedAt?: number
    seq: number
    config: {
      issueTypeIds: string[]
      defaultTypeId: string
      workflows: {
        [key: string]: string
      }
      screens: {
        create: {
          [key: string]: string
        }
        edit: {
          [key: string]: string
        }
        view: {
          [key: string]: string
        }
      }
      fieldSettings: {
        [key: string]: {
          required?: boolean
          hidden?: boolean
          description?: string
        }
      }
      customFieldIds: string[]
      access: {
        visibility: "org" | "private"
        members: {
          type: "user" | "team"
          id: string
          role: "admin" | "viewer" | "member"
        }[]
      }
      permissionSchemeId?: string
      securityLevels: {
        id: string
        name: string
        description?: string
        grants: {
          type: "spaceRole"
          role: "admin" | "viewer" | "member"
        } | {
          type: "orgRole"
          role: string
        } | {
          type: "user"
          id: string
        } | {
          type: "team"
          id: string
        } | {
          type: "reporter"
        } | {
          type: "assignee"
        } | {
          type: "lead"
        } | {
          type: "anyone"
        }[]
      }[]
      defaultSecurityLevelId?: string
      notifications: {
        approval?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        resolved?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        deleted?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        mentioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        created?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        assigned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        updated?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        transitioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        commented?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
      }
      defaultAssignee: "lead" | "unassigned"
      estimation: "count" | "storyPoints" | "originalEstimate"
      boardId?: string
      servicedesk?: {
        requestTypes: {
          id: string
          name: string
          description?: string
          icon?: string
          typeId: string
          group?: string
          fields: string[]
          hidden?: boolean
          approval?: {
            statusId: string
            approvers: object
            needed: "all" | "one"
            approvedStatusId: string
            declinedStatusId: string
          }
        }[]
        queues: {
          id: string
          name: string
          query: string
          columns?: string[]
        }[]
        slas: {
          id: string
          name: string
          start: string[]
          pause: string[]
          stop: string[]
          goals: object[]
        }[]
        hours: {
          timeZone: string
          days: {
            [key: number]: object[]
          }
          holidays: string[]
        }
        portal: {
          enabled: boolean
          title: string
          intro: string
          access: "any" | "org" | "listed"
          customers: string[]
        }
        cannedResponses: {
          id: string
          name: string
          body: string
        }[]
        satisfaction: boolean
        email?: {
          mailboxId: string
          address: string
          requestTypeId: string
        }
        articles?: {
          rootPageId: string
        }
      }
      formerKeys?: string[]
    }
    version: number
    createdAt: number
    updatedAt: number
  }
}

POST/v1/orgs/:orgId/issues/spaces/:spaceKey/restore

Restores an archived space.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

curl -X POST 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/restore' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  space: {
    orgId: string
    spaceId: string
    key: string
    name: string
    description: string
    template: "basic" | "service" | "scrum" | "kanban" | "bugs"
    leadId?: string
    icon?: string
    color?: string
    archived: boolean
    archivedAt?: number
    seq: number
    config: {
      issueTypeIds: string[]
      defaultTypeId: string
      workflows: {
        [key: string]: string
      }
      screens: {
        create: {
          [key: string]: string
        }
        edit: {
          [key: string]: string
        }
        view: {
          [key: string]: string
        }
      }
      fieldSettings: {
        [key: string]: {
          required?: boolean
          hidden?: boolean
          description?: string
        }
      }
      customFieldIds: string[]
      access: {
        visibility: "org" | "private"
        members: {
          type: "user" | "team"
          id: string
          role: "admin" | "viewer" | "member"
        }[]
      }
      permissionSchemeId?: string
      securityLevels: {
        id: string
        name: string
        description?: string
        grants: {
          type: "spaceRole"
          role: "admin" | "viewer" | "member"
        } | {
          type: "orgRole"
          role: string
        } | {
          type: "user"
          id: string
        } | {
          type: "team"
          id: string
        } | {
          type: "reporter"
        } | {
          type: "assignee"
        } | {
          type: "lead"
        } | {
          type: "anyone"
        }[]
      }[]
      defaultSecurityLevelId?: string
      notifications: {
        approval?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        resolved?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        deleted?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        mentioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        created?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        assigned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        updated?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        transitioned?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
        commented?: ("participants" | "reporter" | "assignee" | "watchers" | "lead")[]
      }
      defaultAssignee: "lead" | "unassigned"
      estimation: "count" | "storyPoints" | "originalEstimate"
      boardId?: string
      servicedesk?: {
        requestTypes: {
          id: string
          name: string
          description?: string
          icon?: string
          typeId: string
          group?: string
          fields: string[]
          hidden?: boolean
          approval?: {
            statusId: string
            approvers: object
            needed: "all" | "one"
            approvedStatusId: string
            declinedStatusId: string
          }
        }[]
        queues: {
          id: string
          name: string
          query: string
          columns?: string[]
        }[]
        slas: {
          id: string
          name: string
          start: string[]
          pause: string[]
          stop: string[]
          goals: object[]
        }[]
        hours: {
          timeZone: string
          days: {
            [key: number]: object[]
          }
          holidays: string[]
        }
        portal: {
          enabled: boolean
          title: string
          intro: string
          access: "any" | "org" | "listed"
          customers: string[]
        }
        cannedResponses: {
          id: string
          name: string
          body: string
        }[]
        satisfaction: boolean
        email?: {
          mailboxId: string
          address: string
          requestTypeId: string
        }
        articles?: {
          rootPageId: string
        }
      }
      formerKeys?: string[]
    }
    version: number
    createdAt: number
    updatedAt: number
  }
}

DELETE/v1/orgs/:orgId/issues/spaces/:spaceKey

Deletes an archived space and everything in it, a batch at a time: call again while done is false.

Auth: A person's token or an API key, as Authorization: Bearer.
Scopes: issues:write, issues:admin

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

curl -X DELETE 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  done: boolean
}

GET/v1/orgs/:orgId/issues/spaces/:spaceKey/versions

Versions (releases) of a space.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:read

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

curl 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  versions: {
    versionId: string
    spaceId: string
    name: string
    description: string
    startDate?: string
    releaseDate?: string
    released: boolean
    releasedAt?: number
    archived: boolean
    position: number
    data: {
      deployments?: {
        deploymentId: string
        projectId: string
        label?: string
        at: number
      }[]
    }
  }[]
}

POST/v1/orgs/:orgId/issues/spaces/:spaceKey/versions

Creates a version.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

Request body

descriptionstring
Up to 2,000 characters.
startDatestringor null
Matches ^\d{4}-\d{2}-\d{2}$.
releaseDatestringor null
Matches ^\d{4}-\d{2}-\d{2}$.
archivedboolean
positioninteger
0–1000000.
namestringrequired
1–100 characters. Trimmed.

curl -X POST 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example"
  }'

Send it from this page with your session or a key.

Response 201

{
  version: {
    versionId: string
    spaceId: string
    name: string
    description: string
    startDate?: string
    releaseDate?: string
    released: boolean
    releasedAt?: number
    archived: boolean
    position: number
    data: {
      deployments?: {
        deploymentId: string
        projectId: string
        label?: string
        at: number
      }[]
    }
  }
}

GET/v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId

A version with its issues and progress.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:read

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
versionId
Version id: a saved page version, as listed by the page history, an issue space's version (release, ver_…), or a Drive file's version (fvr_…).

curl 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions/{versionId}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  version: {
    versionId: string
    spaceId: string
    name: string
    description: string
    startDate?: string
    releaseDate?: string
    released: boolean
    releasedAt?: number
    archived: boolean
    position: number
    data: {
      deployments?: {
        deploymentId: string
        projectId: string
        label?: string
        at: number
      }[]
    }
  }
  issues: {
    orgId: string
    issueId: string
    spaceId: string
    number: number
    key: string
    typeId: string
    summary: string
    statusId: string
    statusCategory: "done" | "todo" | "inprogress"
    statusChangedAt?: number
    resolutionId?: string
    resolvedAt?: number
    priorityId?: string
    assigneeId?: string
    reporterId?: string
    creatorId?: string
    labels: string[]
    componentIds: string[]
    fixVersionIds: string[]
    affectsVersionIds: string[]
    dueDate?: string
    startDate?: string
    storyPoints?: number
    originalEstimate?: number
    remainingEstimate?: number
    timeSpent?: number
    environment?: string
    location?: {
      lat: number
      lon: number
      label?: string
    }
    parentId?: string
    sprintId?: string
    closedSprintIds: string[]
    rank: string
    watchers: string[]
    voters: string[]
    securityLevelId?: string
    fields: {
      [key: string]: boolean | null | string | number | string[] | {
        parent: string
        child?: string
      }
    }
    excerpt: string
    statusLog: [string, number][]
    commentCount: number
    attachmentCount: number
    requestTypeId?: string
    channel?: string
    participants: string[]
    requesterEmail?: string
    emailParticipants: string[]
    approvals: {
      id: string
      statusId: string
      approvers: string[]
      needed: "all" | "one"
      decisions: {
        userId: string
        decision: "approved" | "declined"
        at: number
      }[]
      state: "pending" | "approved" | "declined"
      createdAt: number
      decidedAt?: number
    }[]
    satisfaction?: number
    satisfactionComment?: string
    sla: {
      [key: string]: {
        runningSince?: number
        elapsed: number
        paused?: boolean
        stopped?: boolean
        goal?: number
        calendar: "business" | "always"
        breached?: boolean
        startedAt?: number
        stoppedAt?: number
      }
    }
    version: number
    createdAt: number
    updatedAt: number
  }[]
  counts: {
    todo: number
    inprogress: number
    done: number
    total: number
  }
  points: {
    total: number
    done: number
  }
}

PATCH/v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId

Changes a version's name, dates, order or archived state.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
versionId
Version id: a saved page version, as listed by the page history, an issue space's version (release, ver_…), or a Drive file's version (fvr_…).

Request body

namestring
1–100 characters. Trimmed.
descriptionstring
Up to 2,000 characters.
startDatestringor null
Matches ^\d{4}-\d{2}-\d{2}$.
releaseDatestringor null
Matches ^\d{4}-\d{2}-\d{2}$.
archivedboolean
positioninteger
0–1000000.

curl -X PATCH 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions/{versionId}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example",
    "description": "example",
    "startDate": "2026-01-01"
  }'

Send it from this page with your session or a key.

Response 200

{
  version: {
    versionId: string
    spaceId: string
    name: string
    description: string
    startDate?: string
    releaseDate?: string
    released: boolean
    releasedAt?: number
    archived: boolean
    position: number
    data: {
      deployments?: {
        deploymentId: string
        projectId: string
        label?: string
        at: number
      }[]
    }
  }
}

POST/v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId/release

Releases (or unreleases) a version, optionally moving unresolved issues to another version.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
versionId
Version id: a saved page version, as listed by the page history, an issue space's version (release, ver_…), or a Drive file's version (fvr_…).

Request body

releasedboolean
Default true.
moveUnresolvedTostringor null
Up to 64 characters.
releaseDatestring
Matches ^\d{4}-\d{2}-\d{2}$.

curl -X POST 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions/{versionId}/release' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "released": true,
    "moveUnresolvedTo": "example",
    "releaseDate": "2026-01-01"
  }'

Send it from this page with your session or a key.

Response 200

{
  version: {
    versionId: string
    spaceId: string
    name: string
    description: string
    startDate?: string
    releaseDate?: string
    released: boolean
    releasedAt?: number
    archived: boolean
    position: number
    data: {
      deployments?: {
        deploymentId: string
        projectId: string
        label?: string
        at: number
      }[]
    }
  }
  moved: number
}

GET/v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId/notes

Release notes in Markdown: resolved issues grouped by type.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:read

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
versionId
Version id: a saved page version, as listed by the page history, an issue space's version (release, ver_…), or a Drive file's version (fvr_…).

curl 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions/{versionId}/notes' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  markdown: string
  issues: number
}

POST/v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId/deployments

Links (or unlinks) a Cloud deployment to a version.

Auth: A person's token or an API key, as Authorization: Bearer.
Scopes: issues:write, deployments:read

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
versionId
Version id: a saved page version, as listed by the page history, an issue space's version (release, ver_…), or a Drive file's version (fvr_…).

Request body

deploymentIdstringrequired
Up to 64 characters.
projectIdstringrequired
Up to 64 characters.
labelstring
Up to 100 characters.
linkedboolean
Default true.

curl -X POST 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions/{versionId}/deployments' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "deploymentId": "<deploymentId>",
    "projectId": "<projectId>"
  }'

Send it from this page with your session or a key.

Response 200

{
  version: {
    versionId: string
    spaceId: string
    name: string
    description: string
    startDate?: string
    releaseDate?: string
    released: boolean
    releasedAt?: number
    archived: boolean
    position: number
    data: {
      deployments?: {
        deploymentId: string
        projectId: string
        label?: string
        at: number
      }[]
    }
  }
}

DELETE/v1/orgs/:orgId/issues/spaces/:spaceKey/versions/:versionId

Deletes a version, optionally moving its issues to replaceWith.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
versionId
Version id: a saved page version, as listed by the page history, an issue space's version (release, ver_…), or a Drive file's version (fvr_…).

Query parameters

replaceWithstring
Up to 64 characters.

curl -X DELETE 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/versions/{versionId}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  versionId: string
  updated: number
}

GET/v1/orgs/:orgId/issues/spaces/:spaceKey/components

Components of a space.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:read

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

curl 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/components' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  components: {
    componentId: string
    spaceId: string
    name: string
    description: string
    leadId?: string
    defaultAssignee: "space" | "lead" | "unassigned"
  }[]
}

POST/v1/orgs/:orgId/issues/spaces/:spaceKey/components

Creates a component (with an optional lead and default assignee).

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).

Request body

descriptionstring
Up to 2,000 characters.
leadIdstringor null
Up to 64 characters.
defaultAssignee"lead" | "unassigned" | "space"
namestringrequired
1–100 characters. Trimmed.

curl -X POST 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/components' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example"
  }'

Send it from this page with your session or a key.

Response 201

{
  component: {
    componentId: string
    spaceId: string
    name: string
    description: string
    leadId?: string
    defaultAssignee: "space" | "lead" | "unassigned"
  }
}

PATCH/v1/orgs/:orgId/issues/spaces/:spaceKey/components/:componentId

Changes a component.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
componentId
Component id (cmp_…).

Request body

namestring
1–100 characters. Trimmed.
descriptionstring
Up to 2,000 characters.
leadIdstringor null
Up to 64 characters.
defaultAssignee"lead" | "unassigned" | "space"

curl -X PATCH 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/components/{componentId}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example",
    "description": "example",
    "leadId": "<leadId>"
  }'

Send it from this page with your session or a key.

Response 200

{
  component: {
    componentId: string
    spaceId: string
    name: string
    description: string
    leadId?: string
    defaultAssignee: "space" | "lead" | "unassigned"
  }
}

DELETE/v1/orgs/:orgId/issues/spaces/:spaceKey/components/:componentId

Deletes a component and removes it from its issues.

Auth: A person's token or an API key, as Authorization: Bearer.
Scope: issues:write

Get an API key

Path parameters

orgId
Organization id (org_…).
spaceKey
Space key (WEB; former keys work too) or space id (spc_…).
componentId
Component id (cmp_…).

curl -X DELETE 'https://api.cactive.com.au/v1/orgs/{orgId}/issues/spaces/{spaceKey}/components/{componentId}' \
  -H "Authorization: Bearer $CACTIVE_TOKEN"

Send it from this page with your session or a key.

Response 200

{
  componentId: string
  updated: number
}