Generated by API Evangelist
Written by API Evangelist tooling for BlueConic's API. It is a proposal applied on top of the contract, not a document BlueConic publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for BlueConic REST API v2 Groups API
version: 1.0.0
extends: openapi/blueconic-groups-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/groups/{grouptype}/{group}'].get
update:
x-apievangelist-phrasing:
intent: Look up a single group
effect: read
questions:
- What are the property values of one specific group, like a household or company?
- Can I fetch only certain properties of a group?
instructions:
- text: Get group {group} of group type {grouptype}.
slots:
group: path.group
grouptype: path.grouptype
- text: Show the {properties} values for group {group} in group type {grouptype}.
slots:
properties: query.properties
group: path.group
grouptype: path.grouptype
method: generated
generated: '2026-10-01'
- target: $.paths['/groups/{grouptype}'].get
update:
x-apievangelist-phrasing:
intent: List the groups of a group type
effect: read
questions:
- Which groups exist for a given group type?
- Can I filter or page through all groups of one type with a cursor?
- Is there a cap on how many groups a listing will return?
instructions:
- text: List all groups of group type {grouptype}.
slots:
grouptype: path.grouptype
- text: Get {count} groups of type {grouptype} matching {refinement}.
slots:
count: query.count
grouptype: path.grouptype
refinement: query.refinement
- text: Continue listing {grouptype} groups from cursor {cursor}.
slots:
grouptype: path.grouptype
cursor: query.cursor
method: generated
generated: '2026-10-01'
- target: $.paths['/groups'].put
update:
x-apievangelist-phrasing:
intent: Create, update or delete groups in bulk
effect: write
questions:
- How do I create or update several groups in one request?
- Can I delete groups in the same batch call that creates others?
instructions:
- text: Upsert this batch of groups.
- text: Create, update and delete these groups in a single bulk request.
method: generated
generated: '2026-10-01'
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.