Deploy

List Environments

Allows listing environments for a given organization ID.

get/deploy/environments

Request

Base URL
https://circleci.com/api/v2
URL
https://circleci.com/api/v2/deploy/environments
Auth
- API key in header Circle-Token
- or HTTP bearer
- or HTTP basic
- or API key in query parameter circle-token

Query parameters

org-idstring uuid required

An opaque identifier of an organization used in query parameters.

page-sizeinteger required

The number of results per page.

page-tokenstring

A token to specify which page of results to fetch.

Response

Paginated environments list

next_page_tokenstring nullable

The pagination token to use when fetching the next page in this result set.

Example response

{
  "items": [
    {
      "description": "some description",
      "id": "123e4127-e89b-12d3-a456-426123417400",
      "labels": [
        {
          "key": "env",
          "value": "prod"
        }
      ],
      "name": "prod-app"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.