Close

Close Groups API

The groups API from Close — 4 operation(s) for groups.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /group/ List user groups · List Groups for your organization #
Ask an LLM
“What user groups exist in my organization?”
“Does the group list include each group's members?”
Tell an agent
List all groups in my organization.
Show every team group we have.
POST /group/ Create a user group · Create a Group #
Ask an LLM
“How do I create a new team group?”
“Does a group name need to be unique?”
Tell an agent
Create a group named {name}.
Set up a new empty group called {name}.
POST /group/{group_id}/member/ Add a user to a group · Add a User to a Group #
Ask an LLM
“Can I add a teammate to an existing group?”
“What happens if the user is already in the group?”
Tell an agent
Add user {user_id} to group {group_id}.
Put {user_id} into group {group_id}.
DELETE /group/{group_id}/member/{user_id}/ Remove a user from a group · Remove a User from a Group #
Ask an LLM
“Can I take someone out of a group without removing them from the organization?”
“Which call removes a single member from a group?”
Tell an agent destructive · confirm first
Remove user {user_id} from group {group_id}.
Take {user_id} out of group {group_id}.
GET /group/{id}/ Fetch a group and its members · Fetch an individual Group #
Ask an LLM
“Who are the members of a particular group?”
“Can I retrieve one group's details by id?”
Tell an agent
Fetch group {id} with its members.
Show who belongs to group {id}.
PUT /group/{id}/ Rename a group · Update a Group #
Ask an LLM
“Can I rename an existing group?”
“What happens if I rename a group to a name that's already taken?”
Tell an agent
Rename group {id} to {name}.
Change the name of group {id} to {name}.
DELETE /group/{id}/ Delete a group · Delete a Group #
Ask an LLM
“Can I delete a group that's used in a smart view or saved report?”
“Do members lose access to the organization when their group is deleted?”
Tell an agent destructive · confirm first
Delete group {id}.
Remove the group {id} entirely.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/close/refs/heads/main/openapi/close-groups-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/close:close-groups-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

close-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Close CRM REST API
  title: Close Groups API
  version: 1.0.0
servers:
- url: https://api.close.com/api/v1
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: Groups
  externalDocs:
    url: https://developer.close.com/api/resources/groups
paths:
  /group/:
    get:
      operationId: groups_list
      tags:
      - Groups
      summary: List Groups for your organization
      description: Note that list endpoint does not support retrieving members for all groups. Use individual group endpoint instead.
      parameters:
      - $ref: '#/components/parameters/FieldsParam'
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                - id: group_57P6QUf8b4BlepZJYgRj5W
                  name: Support
                  organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
                has_more: false
              schema:
                type: object
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/Group'
                    type: array
                  has_more:
                    type: boolean
                required:
                - data
                - has_more
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      operationId: groups_create
      tags:
      - Groups
      summary: Create a Group
      description: Create a new group. The `name` is required and must be unique within the organization. The group is created with no members. Use the member endpoint to add users.
      parameters:
      - $ref: '#/components/parameters/FieldsParam'
      requestBody:
        content:
          application/json:
            example:
              name: Support
            schema:
              $ref: '#/components/schemas/CreateGroup'
        required: true
      responses:
        '201':
          content:
            application/json:
              example:
                id: group_57P6QUf8b4BlepZJYgRj5W
                members: []
                name: Support
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
              schema:
                $ref: '#/components/schemas/Group'
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /group/{group_id}/member/:
    post:
      operationId: groups_add_member
      tags:
      - Groups
      summary: Add a User to a Group
      description: Add a user to a group by providing the `user_id`. If the user is already a member, nothing changes.
      parameters:
      - in: path
        name: group_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
            schema:
              $ref: '#/components/schemas/CreateGroupMember'
        required: true
      responses:
        '201':
          content:
            application/json:
              example:
                user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
              schema:
                $ref: '#/components/schemas/GroupMember'
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /group/{group_id}/member/{user_id}/:
    delete:
      operationId: groups_remove_member
      tags:
      - Groups
      summary: Remove a User from a Group
      description: If the user is not a member of the group, nothing changes.
      parameters:
      - in: path
        name: group_id
        required: true
        schema:
          type: string
      - in: path
        name: user_id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /group/{id}/:
    get:
      operationId: groups_get
      tags:
      - Groups
      summary: Fetch an individual Group
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/FieldsParam'
      responses:
        '200':
          content:
            application/json:
              example:
                id: group_57P6QUf8b4BlepZJYgRj5W
                members:
                - user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
                name: Support
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
              schema:
                $ref: '#/components/schemas/Group'
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    put:
      operationId: groups_update
      tags:
      - Groups
      summary: Update a Group
      description: You can use this endpoint to rename a Group. If a name is not unique, an error will be returned.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/FieldsParam'
      requestBody:
        content:
          application/json:
            example:
              name: Sales
            schema:
              $ref: '#/components/schemas/CreateGroup'
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                id: group_57P6QUf8b4BlepZJYgRj5W
                members:
                - user_id: user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA
                name: Sales
                organization_id: orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH
              schema:
                $ref: '#/components/schemas/Group'
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    delete:
      operationId: groups_delete
      tags:
      - Groups
      summary: Delete a Group
      description: Delete a group. Members will be removed from the group but not from the organization. Deletion is only allowed if the group is not referenced by saved reports or smart views.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
components:
  parameters:
    FieldsParam:
      description: Comma-separated list of fields to include in the response.
      in: query
      name: _fields
      required: false
      schema:
        type: string
  schemas:
    Group:
      title: Group
      type: object
      properties:
        id:
          title: ID
          type: string
        members:
          title: Members
          default: null
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/GroupMember'
          - type: 'null'
        name:
          title: Name
          type: string
        organization_id:
          title: Organization ID
          type: string
      required:
      - id
      - name
      - organization_id
    CreateGroup:
      title: CreateGroup
      type: object
      properties:
        name:
          title: Name
          type: string
      required:
      - name
      additionalProperties: false
    CreateGroupMember:
      title: CreateGroupMember
      type: object
      properties:
        user_id:
          title: User ID
          type: string
      required:
      - user_id
      additionalProperties: false
    GroupMember:
      title: GroupMember
      type: object
      properties:
        user_id:
          title: User ID
          type: string
      required:
      - user_id
  securitySchemes:
    ApiKeyAuth:
      description: Use your API key as the username and leave the password empty.
      scheme: basic
      type: http
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://app.close.com/oauth2/authorize/
          scopes:
            all.full_access: Full access to all resources
            offline_access: Request a refresh token
          tokenUrl: https://api.close.com/oauth2/token/
      type: oauth2