> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Get flow > Gets one project-scoped WhatsApp Flow draft. Requires `sessions:read`. Project tokens only access resources in their own project. ## OpenAPI ````yaml api-reference/features/engage-at-scale.json GET /platform/flows/{flowId} openapi: 3.0.3 info: title: Engage at scale API methods version: 1.0.0 description: >- Task-focused engage at scale methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/flows/{flowId}: get: tags: - Flows summary: Get flow description: >- Gets one project-scoped WhatsApp Flow draft. Requires `sessions:read`. Project tokens only access resources in their own project. operationId: managementGetFlow parameters: - name: flowId in: path required: true schema: type: string description: Identifier for the flow. - name: projectId in: query required: true schema: type: string description: Identifier of the Polymorfa project that owns this resource. responses: '200': description: Success headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: type: object additionalProperties: false properties: data: type: object allOf: - $ref: '#/components/schemas/management__FlowDraft' nullable: true description: >- Structured data carried by this object. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `object`; Field `status`: `draft` or `ready` or `archived`; Required fields: `id`, `name`, `status`, `version`, `screenCount`, `metaLinks`, `createdAt`, `updatedAt`, `definition` | | Alternative 2 | `null` | required: - data '400': $ref: '#/components/responses/management__BadRequest' '401': $ref: '#/components/responses/management__Unauthorized' '403': $ref: '#/components/responses/management__Forbidden' '404': $ref: '#/components/responses/management__NotFound' security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com - url: http://localhost:8080 description: local dev components: schemas: management__FlowDraft: allOf: - $ref: '#/components/schemas/management__FlowSummary' - type: object properties: definition: type: object additionalProperties: true description: Structured definition for this resource. required: - definition management__FlowSummary: type: object additionalProperties: false properties: id: allOf: - $ref: '#/components/schemas/management__FlowId' description: |- Identifier for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | name: type: string minLength: 1 maxLength: 120 description: |- Human-readable name for this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | String length | `1` through `120` characters | status: type: string enum: - draft - ready - archived description: |- Current status of this resource or operation. **Allowed values** | Value | Meaning | | --- | --- | | `draft` | Draft. | | `ready` | Ready. | | `archived` | Archived. | version: type: string description: Specifies version for this management flow summary. screenCount: type: integer minimum: 0 maximum: 50 description: |- Number of screens. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `50` (inclusive) | metaLinks: type: array items: type: object additionalProperties: true description: Meta links associated with this management flow summary. createdAt: type: integer format: int64 minimum: 0 description: |- Unix timestamp in milliseconds when this resource was created. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | | Format | `int64` | updatedAt: type: integer format: int64 minimum: 0 description: |- Unix timestamp in milliseconds when this resource was last updated. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | | Format | `int64` | required: - id - name - status - version - screenCount - metaLinks - createdAt - updatedAt management__ErrorEnvelope: type: object required: - error - data - docs properties: error: type: object required: - type - code - message - param properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string description: Stable failure code. Use this value for programmatic handling. message: type: string description: Safe explanation of the failure. param: type: string nullable: true description: |- Invalid request field, or null when no field applies. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Documentation link to this failure code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | management__FlowId: type: string format: uuid description: Polymorfa Flow draft UUID. responses: management__BadRequest: description: A path, query, or request-body value did not pass validation. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Unauthorized: description: Missing/invalid credential for this audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Forbidden: description: Authenticated but lacks the required scope/role/audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__NotFound: description: >- The requested resource was not found inside the authenticated organization or project scope. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Polymorfa server credential: a scoped pmfa_ organization key, or a pmfa_pt_ project token on project- and session-bound operations inside its exact authenticated project. Keys may be personal or service-account owned. Both enforce selected action scopes; organization keys can address team resources and every project in the organization. Listener and browser client credentials are rejected. ````