Suites

Get a suite

Accepts both API access tokens and suite-audience OIDC tokens. Pass show_api_token=true to include the API token (requires edit permission on the suite).

get/organizations/{org}/suites/{slug}

Request

  • Base URL: https://api.buildkite.com/v2/analytics
  • URL: https://api.buildkite.com/v2/analytics/organizations/{org}/suites/{slug}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

orgstring required

Organization slug

slugstring required

Suite slug.

Query parameters

show_api_tokenboolean

Response

The suite.

idstring uuid
graphql_idstring
organization_idstring uuid
slugstring
namestring
urlstring uri
web_urlstring uri
default_branchstring
application_namestring nullable
colorstring nullable
emojistring nullable
oidc_policyunknown
api_tokenstring

Only present when show_api_token is requested and permitted.

Changes

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