Teams

Team Object

Teams are represented as JSON objects with the following properties:

Name
Type
Description

id

integer

The unique identifier for the team. Used as the id in the path for retrieving a specific team.

name

string

The display name of the team.

is_active

boolean

Indicates if the team is currently active within ClearFeed.

source

string

The source platform where the team originates (e.g., slack).

source_id

string

The identifier of the team in the source platform (e.g., Slack User Group ID).

created_at

string (ISO 8601)

The timestamp when the team was created in ClearFeed.

updated_at

string (ISO 8601)

The timestamp when the team was last updated in ClearFeed.

team_members

array

(Optional) An array of team member objects. This field is only included if the include=team_members query parameter is specified. Details about the object can be found here.

Team Member Object

Team members associated with a team are represented as JSON objects with the following properties. This object is included within the team_members array when the include=team_members query parameter is specified.

Name
Type
Description

id

string

The User ID (e.g., Slack User ID) of the team member.

created_at

string (ISO 8601)

The timestamp when the member was associated with the team in ClearFeed.

Get All Teams

GET https://api.clearfeed.app/v1/rest/teams

Retrieves a list of all teams configured in your ClearFeed account.

Query Parameters

Name
Type
Description

include

string

(Optional) Must be set to the exact value team_members to include the list of members (team_members array) for each team in the response.

{
  "teams": [
    {
      "id": 1,
      "name": "Team1",
      "is_active": false,
      "source": "slack",
      "source_id": "S07HSCN0ZBN",
      "created_at": "2025-02-28T06:53:05.723Z",
      "updated_at": "2025-02-28T06:53:05.723Z"
    },
    {
      "id": 2,
      "name": "Team2",
      "is_active": false,
      "source": "slack",
      "source_id": "S07J1F0KAQH",
      "created_at": "2025-02-28T06:53:05.723Z",
      "updated_at": "2025-02-28T06:53:05.723Z"
    }
  ]
}

Get Team by ID

GET https://api.clearfeed.app/v1/rest/teams/:id

Retrieves the details of a specific team using its unique ClearFeed identifier.

Path Parameters

Name
Type
Description

id*

integer

The unique identifier (id) of the team you want to retrieve.

Query Parameters

Name
Type
Description

include

string

(Optional) Must be set to the exact value team_members to include the list of members (team_members array) for the team.

{
  "team": {
    "id": 2,
    "name": "Team_name",
    "is_active": true,
    "source": "slack",
    "source_id": "S08FH74RLCA",
    "created_at": "2025-02-28T07:04:21.633Z",
    "updated_at": "2025-03-04T09:05:07.542Z"
  }
}
PreviousCustom FieldsNextTickets

Last updated