Skip to main content

Projects & Environments

GET/v1/orgs/{org_id}/projects

List Projects

Runtime, CI or Admin tokenscope: readoperation_id: projects.list

Authentication

Any bearer token belonging to the org can read this endpoint.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Path parameters

NameTypeRequiredDescription
org_id#pathstringrequired

Header parameters

NameTypeRequiredDescription
X-API-Key#headerstring | nulloptional
authorization#headerstring | nulloptional

Responses

StatusDescription
200Successful Response
422Validation Error

Response schema

idrequiredstring
org_idrequiredstring
namerequiredstring
slugrequiredstring
environmentsobject[]
runtime_keys_createdboolean
runtime_keys
created_atrequiredstring

Errors & what triggers them

CodeTriggerFix
401Missing or expired Authorization header.
403Token does not have org access (wrong org_id, or insufficient role).
404Resource does not exist in this org.

Request

curl -X GET 'https://api.znyx.ai/v1/orgs/00000000-0000-0000-0000-000000000000/projects' \
  -H 'Authorization: Bearer $ZNYX_TOKEN'

Response

application/json

Successful Response

[
  {
    "id": "string",
    "org_id": "string",
    "name": "string",
    "slug": "string",
    "environments": [
      {}
    ],
    "runtime_keys_created": false,
    "runtime_keys": [
      {
        "env_name": "string",
        "env_id": "string",
        "raw_key": "string",
        "key_prefix": "string",
        "expires_at": null
      }
    ],
    "created_at": "string"
  }
]

Schema: ProjectResponse[]