Skip to main content
GET
Get automatic GitHub push deployment status

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

The current automatic deployment configuration and grant status.

branch
string
required
ref
string
required
Pattern: ^refs/heads/
environment
enum<string>
required
Available options:
dev
enabled
boolean
required
generation
integer
required
Required range: x >= 1
grant_status
enum<string>
required
Available options:
active,
revoked
updated_at
string<date-time>
required