Close

Close Roles API

The roles API from Close — 2 operation(s) for roles.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 5

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 /role/ List roles · List all the roles defined for your organization #
Ask an LLM
“What permission roles exist in my organization?”
“Can I see every role defined for our users?”
Tell an agent
List all roles.
Show the organization's permission roles.
POST /role/ Create a custom role · Create a new role #
Ask an LLM
“How do I create a role that can only see leads assigned to them?”
“Can a new role see leads that have no assigned user?”
Tell an agent
Create a new role for sales reps.
Add a custom role that limits lead visibility to assigned leads.
GET /role/{id}/ Fetch a role · Fetch a single role #
Ask an LLM
“Which permissions does a specific role have?”
“Can I retrieve one role by id?”
Tell an agent
Fetch role {id}.
Show the permissions on role {id}.
PUT /role/{id}/ Update a role · Update existing role #
Ask an LLM
“Can I change the permissions on an existing role?”
“Is it possible to rename a role?”
Tell an agent
Update role {id}.
Change the permissions of role {id}.
DELETE /role/{id}/ Delete a custom role · Delete a role #
Ask an LLM
“Can I delete a role that users are still assigned to?”
“Which call removes a custom role?”
Tell an agent destructive · confirm first
Delete role {id}.
Remove the custom role {id}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/close/openapi/close-roles-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-roles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-roles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Close CRM REST API
  title: Close Roles API
  version: 1.0.0
servers:
- url: https://api.close.com/api/v1
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: Roles
  externalDocs:
    url: https://developer.close.com/api/resources/roles
paths:
  /role/:
    get:
      operationId: roles_list
      tags:
      - Roles
      summary: List all the roles defined for your organization
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                - editable: false
                  id: role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p
                  name: Admin
                  permissions:
                  - bulk_edit
                  - export
                  - manage_organization
                  - view_all_leads
                  visibility_user_lcf_behavior: null
                  visibility_user_lcf_ids: null
                - editable: true
                  id: role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p
                  name: Account Manager
                  permissions:
                  - bulk_edit
                  - export
                  visibility_user_lcf_behavior: require_assignment
                  visibility_user_lcf_ids:
                  - cf_pHEkAE3enHZ08zBkYnIAAQDQOT3BBn0DhdF6Kr7Q8Ug
                has_more: false
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    post:
      operationId: roles_create
      tags:
      - Roles
      summary: Create a new role
      description: '`visibility_user_lcf_ids` (optional)


        A list of Lead Custom Field IDs that define which leads user with this role can see. If the role has `view_all_leads` permission, this field should be empty.


        `visibility_user_lcf_behavior` (optional)


        Defines how lead visibility works for leads that don''t have assigned users. If the role has `view_all_leads` permission, this field should be empty.


        - `require_assignment` - leads without assigned users are not visible to this role

        - `allow_unassigned` - leads without assigned users are visible to this role'
      requestBody:
        content:
          application/json:
            example:
              name: Account Manager
              permissions:
              - bulk_edit
              - export
              visibility_user_lcf_behavior: null
              visibility_user_lcf_ids: null
        required: true
      responses:
        '201':
          content:
            application/json:
              example:
                editable: true
                id: role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p
                name: Account Manager
                permissions:
                - bulk_edit
                - export
                visibility_user_lcf_behavior: null
                visibility_user_lcf_ids: null
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
  /role/{id}/:
    get:
      operationId: roles_get
      tags:
      - Roles
      summary: Fetch a single role
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                editable: true
                id: role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p
                name: Account Manager
                permissions:
                - bulk_edit
                - export
                - view_all_leads
                visibility_user_lcf_behavior: null
                visibility_user_lcf_ids: null
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    put:
      operationId: roles_update
      tags:
      - Roles
      summary: Update existing role
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              permissions:
              - bulk_edit
              - view_all_leads
        required: true
      responses:
        '200':
          content:
            application/json:
              example:
                editable: true
                id: role_y6eLquXvRUdmwqi61tsmgCJUU7uGfxaRbDuLoONZL9p
                name: Account Manager
                permissions:
                - bulk_edit
                - view_all_leads
                visibility_user_lcf_behavior: null
                visibility_user_lcf_ids: null
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
    delete:
      operationId: roles_delete
      tags:
      - Roles
      summary: Delete a role
      description: Delete a custom role. You must first move all users off this role by reassigning them to another role.
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
components:
  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
x-provenance:
  method: harvested
  publisher: Close
  source: https://developer.close.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)