Close · Capability

API Endpoints — subpackage_roles

API Endpoints — subpackage_roles. 5 operations. Lead operation: List all the roles defined for your organization. Self-contained Naftiko capability covering one Close business surface.

Run with Naftiko Closesubpackage_roles

What You Can Do

GET

List — List all the roles defined for your organization

/v1/role

POST

Create — Create a new role

/v1/role

GET

Get — Fetch a single role

/v1/role/{id}

PUT

Update — Update existing role

/v1/role/{id}

DELETE

Delete — Delete a role

/v1/role/{id}

MCP Tools

list-all-roles-defined-your

List all the roles defined for your organization

read-only idempotent

create-new-role

Create a new role

fetch-single-role

Fetch a single role

read-only idempotent

update-existing-role

Update existing role

idempotent

delete-role

Delete a role

idempotent

Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: API Endpoints — subpackage_roles
  description: 'API Endpoints — subpackage_roles. 5 operations. Lead operation: List all the roles defined for your organization.
    Self-contained Naftiko capability covering one Close business surface.'
  tags:
  - Close
  - subpackage_roles
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CLOSE_API_KEY: CLOSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: close-subpackage-roles
    baseUri: https://api.close.com/api/v1
    description: API Endpoints — subpackage_roles business capability. Self-contained, no shared references.
    resources:
    - name: role
      path: /role/
      operations:
      - name: list
        method: GET
        description: List all the roles defined for your organization
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
      - name: create
        method: POST
        description: Create a new role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: role-id
      path: /role/{id}/
      operations:
      - name: get
        method: GET
        description: Fetch a single role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
      - name: update
        method: PUT
        description: Update existing role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete a role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Use your API key as the username and leave the password empty.
          required: true
    authentication:
      type: bearer
      token: '{{env.CLOSE_API_KEY}}'
  exposes:
  - type: rest
    namespace: close-subpackage-roles-rest
    port: 8080
    description: REST adapter for API Endpoints — subpackage_roles. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/role
      name: role
      description: REST surface for role.
      operations:
      - method: GET
        name: list
        description: List all the roles defined for your organization
        call: close-subpackage-roles.list
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create a new role
        call: close-subpackage-roles.create
        with:
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/role/{id}
      name: role-id
      description: REST surface for role-id.
      operations:
      - method: GET
        name: get
        description: Fetch a single role
        call: close-subpackage-roles.get
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update
        description: Update existing role
        call: close-subpackage-roles.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete a role
        call: close-subpackage-roles.delete
        with:
          id: rest.id
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: close-subpackage-roles-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Endpoints — subpackage_roles. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-roles-defined-your
      description: List all the roles defined for your organization
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: close-subpackage-roles.list
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-role
      description: Create a new role
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: close-subpackage-roles.create
      with:
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fetch-single-role
      description: Fetch a single role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: close-subpackage-roles.get
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-existing-role
      description: Update existing role
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: close-subpackage-roles.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-role
      description: Delete a role
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: close-subpackage-roles.delete
      with:
        id: tools.id
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.