deployments

List all Deployments

Changed on

Returns a list of your organization's deployments, newest first. Results are returned in reverse chronological order. Each deployment's routes carry the effective state as of that deployment — the newest route per (resource template, environment) key at or before it. Pass filter[changes-only]=true to render only the rows each deployment wrote, so the list reads as a change history. filter[environment-id] and filter[template-id] narrow both the deployments listed and the routes each one carries. This endpoint requires a production API key; sandbox API keys receive 401.

get/deployments

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/deployments
  • Auth: HTTP bearer

Query parameters

afterstring

Object ID for pagination cursor

beforestring

Object ID for pagination cursor

sizenumber double

Limit on the number of objects returned

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

environment-idstring

Filter deployments and routes to a single environment.

template-idstring

Filter deployments and routes to a single resource template.

changes-onlyboolean

When true, each deployment renders only the routes it wrote rather than the effective state as of it.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Response

This endpoint returns a collection of Deployment objects.

Changes