Skip to content
English
  • There are no suggestions because the search field is empty.

Retrieve team spaces

This endpoint allows you to retrieve a list of teams to which the user is assigned and can be used for various purposes.

This endpoint allows you to retrieve a list of teams to which the user is assigned and can be used for various purposes, such as displaying available teams within the application or selecting a team for further operations.

Request

  • Method: GET
  • Path: /external/v0/zapier/webhooks/teams
  • Header:
  • X-KEY: API key for authentication.

Response

After successfully returning teams, you will receive response in JSON format with information about the specific team:

[

  {

    "id": 281698,

    "state": "OPEN",

    "visibility": "PRIVATE",

    "tags": {},

    "parentTeam": null,

    "deleted": false,

    "deletedAt": null,

    "premium": true,

    "billing": true,

    "principalRole": "MEMBER",

    "name": "Beenia testing team",

    "externalId": null

  },

  ...

]


Description of attributes:

  • id: Unique team identifier.
  • state: Team status, which can be "OPEN" or "CLOSE."
  • visibility: Team visibility, which can be "PRIVATE" or "PUBLIC."
  • tags: Field containing tags or labels assigned to the team.
  • parentTeam: Reference to the parent team, if defined.
  • deleted: Indicator of whether the team is marked as deleted (true) or not (false).
  • deletedAt: Date and time of team deletion, if it's deleted.
  • premium: Indicator of whether the team is marked as premium (true) or not (false).
  • billing: Indicator of whether the team is included in billing (true) or not (false).
  • principalRole: User's principal role in the team.
  • name: Team name.
  • externalId: External team identifier, if defined.


Retrieve activity sections for Team

This endpoint allows you to retrieve information about all sections for activities within a specific team. This information enables you to efficiently organize work within the team and assign tasks to individual sections. 

Request

  • Method: GET
  • Path: /external/v0/zapier/webhooks/teams/{teamId}/activities/sections
  • Header:
  • X-KEY: API key for authentication.
  • Path variables:
  • teamId(number): Unique team identifier.

Response

After successfully retrieving activity sections, you will receive response in JSON format with the following information:

[

  {

    "id": 21550,

    "state": "OPEN",

    "deleted": false,

    "lastModified": "2023-09-18T09:52:57.848Z",

    "assignee": [],

    "tags": {},

    "sortOrder": 47101.0,

    "name": "testing section",

    "description": null,

    "color": "#74A4FF",

    "externalId": null,

    "dueDate": null

  },

  ...

]


Description of attributes:

  • id: Unique identifier of the section.
  • state: Section state, which can be "OPEN" or "CLOSE."
  • deleted: Indicator of whether the section is marked as deleted (true) or not (false).
  • lastModified: Date of the last section modification.
  • assignee: Array containing information about assigned individuals or users to the section.
  • tags: Array containing tags or labels assigned to the section.
  • sortOrder: Number determining the order of the section within the team.
  • name: Section name.
  • description: Section description.
  • color: Section color in hexadecimal format.
  • externalId: External identifier of the section if defined.
  • dueDate: Planned due date and time of the section if defined.