> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> API reference for Buildkite: every `buildkite.api.*` operation with input and output types.

Every `buildkite.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Get Current Access Token

### getCurrentAccessToken

`getCurrentAccessToken`

Retrieve the authenticated API access token details. Use when you need to confirm the validity and scopes of the current API token.

**Risk:** `read`

```ts theme={null}
await corsair.buildkite.api.getCurrentAccessToken({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `uuid` | `string` | Yes | — |
| `scopes` | `string[]` | Yes | — |
| `description` | `string \| null` | No | — |
| `created_at` | `string` | No | — |
| `expires_at` | `string \| null` | No | — |
| `user` | `object` | No | — |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   email?: string,
>   name?: string
> }
> ```

***

## Get Meta

### getMeta

`getMeta`

Retrieve metadata about the Buildkite API. Use when you need to fetch webhook IP addresses for firewall or security configurations.

**Risk:** `read`

```ts theme={null}
await corsair.buildkite.api.getMeta({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `webhook_ips` | `string[]` | Yes | — |

***

## Get User

### getUser

`getUser`

Retrieve details about the current authenticated user. Use when you need to get information about the user account that owns the API token.

**Risk:** `read`

```ts theme={null}
await corsair.buildkite.api.getUser({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `string` | Yes | — |
| `graphql_id` | `string` | No | — |
| `name` | `string` | Yes | — |
| `email` | `string` | Yes | — |
| `avatar_url` | `string` | No | — |
| `created_at` | `string` | No | — |

***

## List Organizations

### listOrganizations

`listOrganizations`

List all organizations the current user is a member of. Use when you need to discover available organizations or get organization slugs for other operations.

**Risk:** `read`

```ts theme={null}
await corsair.buildkite.api.listOrganizations({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id: string,
>   graphql_id?: string,
>   url?: string,
>   web_url?: string,
>   name: string,
>   slug: string,
>   pipelines_url?: string,
>   agents_url?: string,
>   emojis_url?: string,
>   created_at?: string
> }[]
> ```

***

## List Pipeline Agents

### listPipelineAgents

`listPipelineAgents`

List connected agents for an organization. Use after confirming the organization slug. Supports optional filtering and pagination.

**Risk:** `read`

```ts theme={null}
await corsair.buildkite.api.listPipelineAgents({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `orgSlug` | `string` | Yes | Official path param \{org.slug} on GET /v2/organizations/\{org.slug}/agents |
| `name` | `string` | No | Official query: ?name= |
| `hostname` | `string` | No | Official query: ?hostname= |
| `version` | `string` | No | Official query: ?version= |
| `cluster_queue_id` | `string` | No | Official query: ?cluster\_queue\_id= |
| `page` | `number` | No | — |
| `per_page` | `number` | No | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id: string,
>   graphql_id?: string,
>   url?: string,
>   web_url?: string,
>   name: string,
>   connection_state: never_connected | connected | disconnected | stopping | stopped | lost,
>   hostname?: string,
>   ip_address?: string,
>   user_agent?: string,
>   version?: string,
>   os_id?: string,
>   arch?: string,
>   queue?: string,
>   creator?: {
>     id?: string,
>     graphql_id?: string,
>     name?: string,
>     email?: string,
>     avatar_url?: string,
>     created_at?: string
>   } | null,
>   created_at?: string,
>   connected_at?: string | null,
>   disconnected_at?: string | null,
>   lost_at?: string | null,
>   stopped_at?: string | null,
>   job?: {
>     id?: string,
>     graphql_id?: string,
>     type?: string,
>     name?: string,
>     state?: string,
>     command?: string
>   } | null,
>   last_job_finished_at?: string | null,
>   priority?: number | null,
>   meta_data?: string[]
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.