Documentation (2024.2 Enterprise)

# Subscriber

A subscriber is a User or a Collaborator who receives notifications from a subscribable. The currently supported subscribables are Project and Task.

- Operations
  - For Projects
    - `GET /projects/:project_id/subscribers`
    - `GET /projects/:project_id/subscribers/:id`
    - `POST /projects/:project_id/actions/subscribe`
    - `DELETE /projects/:project_id/actions/unsubscribe`
  - For Tasks
    - `GET /projects/:project_id/tasks/:task_id/subscribers`
    - `GET /projects/:project_id/tasks/:task_id/subscribers/:id`
    - `POST /projects/:project_id/tasks/:task_id/actions/subscribe`
    - `DELETE /projects/:project_id/tasks/:task_id/actions/unsubscribe`

## Operations

### GET /projects/:project_id/subscribers

Get all subscribers for a Project, with optional limit and offset parameters, as a metadata-results object.

#### Example Request

    curl -X GET \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/subscribers

#### Example Response

See User or Collaborator docs for an example response.

### GET /projects/:project_id/subscribers/:id

Get a specific Project subscriber.

#### Example Request

    curl -X GET \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/subscribers/norris

#### Example Response

See User or Collaborator docs for an example response.

### POST /projects/:project_id/actions/subscribe

Subscribe to a Project.

#### Example Request

    curl -X POST \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/actions/subscribe

#### Example Response

    {
      "api_status": 201,
      "api_timestamp": "2014-11-27T11:11:25Z"
    }

### DELETE /projects/:project_id/actions/unsubscribe

Unsubscribe from a Project.

#### Example Request

    curl -X DELETE \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/actions/unsubscribe

#### Example Response

    {
      "api_status": 200,
      "api_timestamp": "2014-11-27T11:11:25Z"
    }

### GET /projects/:project_id/tasks/:task_id/subscribers

Get all subscribers for a Task, with optional limit and offset parameters, as a metadata-results object.

#### Example Request

    curl -X GET \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/tasks/1/subscribers

#### Example Response

See User or Collaborator docs for an example response.

### GET /projects/:project_id/tasks/:task_id/subscribers/:id

Get a specific Task subscriber.

#### Example Request

    curl -X GET \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/tasks/1/subscribers/norris

#### Example Response

See User or Collaborator docs for an example response.

### POST /projects/:project_id/tasks/:task_id/actions/subscribe

Subscribe to a Task.

#### Example Request

    curl -X POST \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/tasks/1/actions/subscribe

#### Example Response

    {
      "api_status": 201,
      "api_timestamp": "2014-11-27T11:11:25Z"
    }

### DELETE /projects/:project_id/tasks/:task_id/actions/unsubscribe

Unsubscribe from a Task.

#### Example Request

    curl -X DELETE \
      -H "Accept: application/vnd.hth.v1" \
      -H "Authorization: hth.company_key='$COMPANY_KEY',account_key='$ACCOUNT_KEY'" \
      https://helixteamhub.cloud/api/projects/platform/tasks/1/actions/unsubscribe

#### Example Response

    {
      "api_status": 200,
      "api_timestamp": "2014-11-27T11:11:25Z"
    }

Your search for returned results

Your search for returned results