Environments

List Environments

Retrieve a list of Environments you can access. Use the optional project query parameter to return only Environments in one Project. When project is set, paging totals and next cursors reflect the filtered set.

get/api/v1/environments

Request

  • Base URL: https://app.coalescesoftware.io
  • URL: https://app.coalescesoftware.io/api/v1/environments
  • Auth: HTTP bearer

Query parameters

detailboolean

Include the full detail of the environments.

projectstring

Filter results to Environments in this Project ID. Omit or pass an empty value to return Environments across all Projects the caller can access.

limitinteger

The maximum number of items to return. Between 1 and 500.

startingFromstring

A cursor that tells the API where to begin returning results. Use it to continue pagination from a specific point in the dataset. This value must come from the next field in the previous response. If you define a query cursor using startingFrom, you must also include the orderBy parameter.

orderBystring
Example:id

The field to order the results by. Only id allowed.

Response

A collection of environment information.

totalinteger

Number of records returned.

startingFromstring

A cursor that tells the API where to begin returning results. Use it to continue pagination from a specific point in the dataset. This value must come from the next field in the previous response. If you define a query cursor using startingFrom, you must also include the orderBy parameter.

limitinteger

Limit of the records returned. Some endpoints have limit as a query parameter. Default is 100.

nextnumber nullable

The field value representing the start of the next page of results.

Example response

{
  "data": [
    {
      "createdBy": {
        "id": "BGx8EQ1NlLXxMFwFfV5brGgLj813",
        "firstName": "Coalesce",
        "lastName": "Support"
      }
    }
  ]
}

Changes

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