canonical: https://jentic.com/apis/virtserver.swaggerhub.com/virtserver-swaggerhub

# Virtserver Swaggerhub Purespectrum BuyAPI

BuyAPI enables Purespectrum partners to load and field surveys via API. Contact us though www.purespectrum.com for additional information. The API exposes 26 endpoints secured with apiKey authentication.

## For AI agents

Programmatically add a new survey to the platform, retrieve a survey by its purespectrum id. Covers 26 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Add a new survey to the platform
- Retrieve a survey by its Purespectrum id
- Edit an existing survey.
- Deletes a survey
- Create qualifications
- Read qualifications

## Use cases

### CRM Operations

Use the Purespectrum BuyAPI to perform crm operations programmatically. The API provides 26 endpoints covering core functionality including add a new survey to the platform, retrieve a survey by its purespectrum id, edit an existing survey..

Example prompt: Call POST /surveys to add a new survey to the platform

### Automated a) surveys Management

Automate a) surveys operations by combining multiple Purespectrum BuyAPI endpoints. Agents can retrieve a survey by its purespectrum id and then edit an existing survey. in a single workflow.

Example prompt: Call GET `/surveys/{ps_survey_id}` to retrieve a survey by its purespectrum id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Purespectrum BuyAPI endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'add a new survey to the platform', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/surveys` | Add a new survey to the platform |
| GET | `/surveys/{ps_survey_id}` | Retrieve a survey by its Purespectrum id |
| PUT | `/surveys/{ps_survey_id}` | Edit an existing survey. |
| DELETE | `/surveys/{ps_survey_id}` | Deletes a survey |
| POST | `/surveys/{ps_survey_id}/qualifications` | Create qualifications |
| GET | `/surveys/{ps_survey_id}/qualifications` | Read qualifications |
| PUT | `/surveys/{ps_survey_id}/qualifications` | Edit qualifications |
| DELETE | `/surveys/{ps_survey_id}/qualifications` | Delete all qualifications |

## Key resources

- **a) surveys** — Operations related to a) surveys
- **b) surveys{id}** — Operations related to b) surveys{id}
- **c) qualifications** — Operations related to c) qualifications
- **d) qualifications{id}** — Operations related to d) qualifications{id}
- **e) quotas** — Operations related to e) quotas

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 70 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 72 / 100
  - AI-Readiness & Agent Experience: 58 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 65 / 100
- **View full report:** https://jentic.com/apis/virtserver.swaggerhub.com/virtserver-swaggerhub/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Purespectrum BuyAPI by hand means passing its api_key header and managing the survey and qualification lifecycle yourself. Through Jentic you install once, import the Purespectrum BuyAPI from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Purespectrum puts the survey id in the URL path (`/surveys/{ps_survey_id}`), so a rule can pin your agent to one survey and the operations around it. You choose the operations it may call, so a destructive one like deleting a survey or its qualifications is not included unless you add it.
- **Credential handling:** Your Purespectrum API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a new survey' or 'set survey qualifications', and Jentic returns the matching Purespectrum operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Purespectrum BuyAPI use?

The Purespectrum BuyAPI uses an API key passed in the `api_key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I add a new survey to the platform with the Purespectrum BuyAPI?

Yes. Use the POST /surveys endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Purespectrum BuyAPI?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I add a new survey to the platform through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'add a new survey to the platform'. Jentic returns the matching Purespectrum BuyAPI operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Purespectrum BuyAPI have?

The Purespectrum BuyAPI exposes 26 endpoints covering a) surveys, b) surveys{id}, c) qualifications operations.

### Can I limit what my agent is allowed to do with the Purespectrum BuyAPI?

Yes. Jentic One is self-hosted by you, so your own rules decide which Purespectrum BuyAPI operations and credentials your agent can use. Because the survey id sits in the URL path (`/surveys/{ps_survey_id}`), a rule can pin the agent to a single survey and the qualification and quota operations around it. You also choose which operations are allowed, so a destructive call like DELETE `/surveys/{ps_survey_id}` or its qualifications is excluded unless you add it, and your API key stays encrypted in your own instance and out of the agent context.