Resources

Keyword groups

Groups such as Brand, Commercial, Informational, Transactional, Local or Custom organize keywords for reporting.

GET/api/v1/keyword-groupsRead key

List keyword groups

Authentication: Bearer API key in the Authorization header.

Parameters
Parameter	In	Type	Description
websiteId	query	string	Only groups for this website

Request

curl "https://rankspire.tech/api/v1/keyword-groups" \
  -H "Authorization: Bearer $RANKSPIRE_KEY"

Response

{ "data": [{ "id": "cm1grp…", "name": "Commercial", "type": "commercial", "websiteId": "cm1site9x0001", "keywords": 42 }] }

POST/api/v1/keyword-groupsRead & write key

Create a keyword group

Authentication: Bearer API key in the Authorization header.

Parameters
Parameter	In	Type	Description
name*	body	string	Group name
type	body	brand \| commercial \| informational \| transactional \| local \| custom	Default custom
websiteId	body	string	Optional — workspace-wide when omitted

Request

curl -X POST "https://rankspire.tech/api/v1/keyword-groups" \
  -H "Authorization: Bearer $RANKSPIRE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Pricing pages", "type": "commercial", "websiteId": "cm1site9x0001" }'

Response

{ "data": { "id": "cm1grp…", "name": "Pricing pages", "type": "commercial" } }

DELETE/api/v1/keyword-groups/{id}Read & write key

Delete a group (keywords are kept)

Authentication: Bearer API key in the Authorization header.

Request

curl -X DELETE "https://rankspire.tech/api/v1/keyword-groups/cm1site9x0001" \
  -H "Authorization: Bearer $RANKSPIRE_KEY"

Response

{ "data": { "deleted": true } }