# Popp Workflows API

**Canonical:** https://apis.io/apis/popp/popp-workflows-api/  
**Provider:** Popp — https://apis.io/providers/popp/  
**Base URL:** https://api.joinpopp.com/v1  
**Documentation:** https://joinpopp.com/api

Popp Workflows API is one of 18 APIs that [Popp](https://apis.io/providers/popp/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and 6 JSON Schemas.

The Workflows API from Popp — 20 operation(s) for workflows.

## Operations (24)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/candidate-profiles/by-external-id/{externalId}` | Get candidate profile by external ID |
| GET | `/v1/workflow-runs/{runId}` | Get workflow run |
| POST | `/v1/workflow-runs/{runId}/cancel` | Cancel workflow run |
| POST | `/v1/workflows` | Create workflow |
| GET | `/v1/workflows` | List workflows |
| GET | `/v1/workflows/by-external-id/{externalId}` | Get workflow by external ID |
| PATCH | `/v1/workflows/by-external-id/{externalId}` | Update workflow by external ID |
| POST | `/v1/workflows/by-external-id/{externalId}/archive` | Archive workflow by external ID |
| POST | `/v1/workflows/by-external-id/{externalId}/pause` | Pause workflow by external ID |
| POST | `/v1/workflows/by-external-id/{externalId}/publish` | Publish workflow by external ID |
| POST | `/v1/workflows/by-external-id/{externalId}/resume` | Resume workflow by external ID |
| POST | `/v1/workflows/by-external-id/{externalId}/runs` | Start workflow runs by external ID |
| GET | `/v1/workflows/{workflowId}` | Get workflow |
| PATCH | `/v1/workflows/{workflowId}` | Update workflow |
| GET | `/v1/workflows/{workflowId}/analyses/{workflowNodeSlug}` | Get workflow analysis (Beta) |
| GET | `/v1/workflows/{workflowId}/analyses/{workflowNodeSlug}/applications` | List workflow analysis applications (Beta) |
| GET | `/v1/workflows/{workflowId}/analyses/{workflowNodeSlug}/applications/{candidateId}` | Get workflow analysis application (Beta) |
| GET | `/v1/workflows/{workflowId}/analyses/{workflowNodeSlug}/applications/{candidateId}/history` | List workflow analysis application history (Beta) |
| POST | `/v1/workflows/{workflowId}/archive` | Archive workflow |
| POST | `/v1/workflows/{workflowId}/pause` | Pause workflow |
| POST | `/v1/workflows/{workflowId}/publish` | Publish workflow |
| POST | `/v1/workflows/{workflowId}/resume` | Resume workflow |
| POST | `/v1/workflows/{workflowId}/runs` | Start workflow runs |
| GET | `/v1/workflows/{workflowId}/runs` | List workflow runs |

## Machine-readable artifacts (17)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/openapi/popp-workflows-api-openapi.yml
- **Documentation** — https://docs.joinpopp.com/
- **APIReference** — https://docs.joinpopp.com/docs/quickstart
- **GettingStarted** — https://docs.joinpopp.com/docs/quickstart
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/authentication/popp-authentication.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/asyncapi/popp-webhooks.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/conventions/popp-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/errors/popp-problem-types.yml
- **Lifecycle** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/lifecycle/popp-lifecycle.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/data-model/popp-data-model.yml
- **Conformance** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/conformance/popp-conformance.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/json-schema/popp-update-meeting-template-input-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/json-schema/popp-create-meeting-template-input-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/json-schema/popp-create-scheduling-conversation-input-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/json-schema/popp-create-campaign-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/json-schema/popp-list-campaigns-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/popp/refs/heads/main/json-schema/popp-list-ats-jobs-response-schema.json

## Other Popp APIs (12)

- [Popp Agents API](https://apis.io/apis/popp/popp-agents-api/)
- [Popp Analysis API](https://apis.io/apis/popp/popp-analysis-api/)
- [Popp ATS API](https://apis.io/apis/popp/popp-ats-api/)
- [Popp Campaigns API](https://apis.io/apis/popp/popp-campaigns-api/)
- [Popp Candidate Lists API](https://apis.io/apis/popp/popp-candidate-lists-api/)
- [Popp Candidates API](https://apis.io/apis/popp/popp-candidates-api/)
- [Popp Conversations API](https://apis.io/apis/popp/popp-conversations-api/)
- [Popp Custom Fields (Beta) API](https://apis.io/apis/popp/popp-custom-fields-beta-api/)
- [Popp Document Credentials API](https://apis.io/apis/popp/popp-document-credentials-api/)
- [Popp Documents API](https://apis.io/apis/popp/popp-documents-api/)
- [Popp Organization Configuration API](https://apis.io/apis/popp/popp-organization-configuration-api/)
- [Popp Organizations API](https://apis.io/apis/popp/popp-organizations-api/)

## Tags

Workflows

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/popp/popp-workflows-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/popp/.