Codefresh

Codefresh Teams API

teams

Documentation GitHub OpenAPI

Operations 8

POST /team Create #

GET /team List #

DELETE /team/{teamId} Delete #

GET /team/group/synchronize/name/{name}/type/{type} Synchronize client with group #

PUT /team/{teamId}/{userId}/assignUserToTeam Add user #

PUT /team/{teamId}/renameTeam Rename team #

PUT /team/{teamId}/{userId}/deleteUserFromTeam Remove user #

GET /team/{userId}/findTeamsByUser List by user #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-teams-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/codefresh:codefresh-teams-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  contact:
    name: Codefresh
    url: https://www.codefresh.io
  description: Codefresh API openAPI 3.0 specification
  termsOfService: https://codefresh.io/docs/docs/terms-and-privacy-policy/terms-of-service/
  title: Codefresh Teams API
  version: 0.0.2
  x-logo:
    url: https://g.codefresh.io/modules/cf.resources/codefresh-api-docs-images/codefresh-logo-api.svg
    backgroundColor: '#FFFFFF'
    altText: Codefresh
servers:
- url: https://g.codefresh.io/api
security:
- API-key: []
tags:
- name: Teams
  description: teams
  x-id: teams
paths:
  /team:
    post:
      x-action: createTeam
      x-audit:
        name:
          path: body.name
          source: req
        id:
          path: _id
          source: res
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Teams
      operationId: teams-create
      requestBody:
        content:
          application/json:
            schema:
              properties:
                tags:
                  items:
                    type: string
                  type: array
                name:
                  type: string
                users:
                  items:
                    type: string
                  type: array
              type: object
        description: Team data
        required: true
      summary: Create
      parameters: []
      x-sdk-interface: teams.create
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X POST \\\n    -H \"Authorization: ${API_KEY}\" \\\n    -H 'Content-Type: application/json; charset=utf-8' \\\n    -d \"{\\\"tags\\\":[\\\"${TAGS_ARR_STR}\\\"],\\\"name\\\":\\\"${NAME_STR}\\\",\\\"users\\\":[\\\"${USERS_ARR_STR}\\\"]}\" \\\n    \"https://g.codefresh.io/api/team\""
      - lang: node.js
        source: "sdk.teams.create({\n    tags: [\n        `${TAGS_ARR_STR}`\n    ],\n    name: `${NAME_STR}`,\n    users: [\n        `${USERS_ARR_STR}`\n    ]\n})"
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Teams
      operationId: teams-list
      parameters: []
      summary: List
      x-sdk-interface: teams.list
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/team\""
      - lang: node.js
        source: sdk.teams.list()
  /team/{teamId}:
    delete:
      x-action: deleteTeam
      x-entityId: params.teamId
      x-sdk-interface: teams.delete
      operationId: teams-delete
      summary: Delete
      parameters:
      - in: path
        name: teamId
        schema:
          type: string
        required: true
        description: team id
      responses:
        '200':
          description: ok
      tags:
      - Teams
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X DELETE \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/team/${TEAM_ID}\""
      - lang: node.js
        source: sdk.teams.delete({ teamId })
  /team/group/synchronize/name/{name}/type/{type}:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Teams
      operationId: teams-synchronize-client-with-group
      parameters:
      - in: path
        name: name
        schema:
          type: string
        required: true
        description: Name
      - in: path
        name: type
        schema:
          type: string
        required: true
        description: Type
      - in: query
        name: access_token
        schema:
          type: string
        description: Access token
      - in: query
        name: disableNotifications
        schema:
          type: boolean
        required: false
        description: Disable send notifications
      summary: Synchronize client with group
      x-sdk-interface: teams.synchronizeClientWithGroup
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/team/group/synchronize/name/${NAME}/type/${TYPE}?access_token=${ACCESS_TOKEN}&disableNotifications=${DISABLE_NOTIFICATIONS}\""
      - lang: node.js
        source: "sdk.teams.synchronizeClientWithGroup({\n    name,\n    type,\n    access_token,\n    disableNotifications\n})"
  /team/{teamId}/{userId}/assignUserToTeam:
    put:
      x-action: assignUserToTeam
      x-entityId: params.teamId
      parameters:
      - description: The id of the team
        in: path
        name: teamId
        required: true
        schema:
          type: string
      - description: The user id for assign
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Teams
      operationId: teams-add-user
      summary: Add user
      x-sdk-interface: teams.addUser
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X PUT \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/team/${TEAM_ID}/${USER_ID}/assignUserToTeam\""
      - lang: node.js
        source: sdk.teams.addUser({ teamId, userId })
  /team/{teamId}/renameTeam:
    put:
      x-action: renameTeam
      x-entityId:
        pathId: params.teamId
        pathName: body.name
      parameters:
      - description: The id of the team
        in: path
        name: teamId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ok
      tags:
      - Teams
      operationId: teams-rename
      summary: Rename team
      x-sdk-interface: teams.rename
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X PUT \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/team/${TEAM_ID}/renameTeam\""
      - lang: node.js
        source: sdk.teams.rename({ teamId })
  /team/{teamId}/{userId}/deleteUserFromTeam:
    put:
      x-action: deleteUserFromTeam
      x-entityId: params.teamId
      parameters:
      - description: The id of the team
        in: path
        name: teamId
        required: true
        schema:
          type: string
      - description: The user id for assign
        in: path
        name: userId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Teams
      operationId: teams-remove-user
      summary: Remove user
      x-sdk-interface: teams.removeUser
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X PUT \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/team/${TEAM_ID}/${USER_ID}/deleteUserFromTeam\""
      - lang: node.js
        source: sdk.teams.removeUser({ teamId, userId })
  /team/{userId}/findTeamsByUser:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: json
      tags:
      - Teams
      operationId: teams-list-by-user
      parameters:
      - in: path
        name: userId
        schema:
          type: string
        required: true
        description: User id
      summary: List by user
      x-sdk-interface: teams.listByUser
      x-code-samples:
      - lang: curl
        source: "curl  \\\n    -X GET \\\n    -H \"Authorization: ${API_KEY}\" \\\n    \"https://g.codefresh.io/api/team/${USER_ID}/findTeamsByUser\""
      - lang: node.js
        source: sdk.teams.listByUser({ userId })
components:
  securitySchemes:
    API-key:
      in: header
      name: Authorization
      description: 'An api key got from: User Settings -> API keys -> Generate'
      type: apiKey
x-service-name: api-public
x-base-path: /api
x-internal-services:
- pipeline-manager
- api
x-endpoint-conditions:
- weight: 0
  condition: global.has-general-service-role
  handlerRegex: (.*)
- weight: 1
  condition: global.has-kubernetes-endpoints-service-role
  handlerRegex: kubernetes\.\w+
- weight: 2
  condition: global.has-auth-service-role
  handlerRegex: api-key\.\w+
x-tagGroups:
- name: Pipelines / Builds
  tags:
  - Annotations
  - Builds
  - Execution Contexts
  - Images
  - Pipelines
  - Progress
  - Projects
  - Step-types
  - Triggers
  - Triggers Events
  - Triggers Types
- name: Kubernetes / Helm
  tags:
  - Environments V2
  - Helm Boards
  - Helm Charts
  - Helm Releases
  - Helm Sections
  - Kubernetes
- name: Swarm
  tags:
  - Compositions
  - Environments
- name: Integrations / Contexts
  tags:
  - Clusters
  - Contexts
  - Helm Cluster Configs
  - Helm Repos
  - Registries
  - Repos
- name: Account Management
  tags:
  - Abac
  - Accounts
  - Agents
  - Audit
  - Runtime Environments
  - Teams
  - Tokens
  - Views
- name: User Properties
  tags:
  - favorites
- name: On-Premise
  tags:
  - Features
  - Runtime Environments (Account)
  - Runtime Environments (Plan)
  - Runtime Environments (System)
  - Runtime Environments.
- name: Platform Analytics
  tags:


# --- truncated at 32 KB (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-teams-api-openapi.yml