# List connection candidates

GET

/v1/connection-choices/candidates

```sh
curl --request GET \
  --url 'https://example.com/v1/connection-choices/candidates?projectId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&owner=me&limit=25' \
  --header 'Authorization: Bearer <token>'
```

The connections a choice in the project may name: live ones, working or needing a reconnect, in this server’s environment, on a live registration that allows the project. The company’s: the project’s admins read each in full, and its members read `connectionId` and `name` only (`read` on the project). With `owner=me`, the caller’s own instead, in full, with `main`.

## Authorizations

- **[bearerAuth](https://docs.kindgi.com/v0.5.0/reference/api.md#bearerauth)**

## Parameters

### Query Parameters

**projectId**

required

string format: uuid

The project.

**app**

string

Only this app’s (its entry id).

**owner**

string

Allowed values: me

`me`: only the caller’s own, even for a tenant admin.

**limit**

integer

default: 25 >= 1 <= 100

1..100. Default 25.

**cursor**

string

Where the previous page ended: its `nextCursor`, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise `400 bad-input`, and the list starts again without it. Absent → first page.

## Responses

### 200

Page of candidates.

application/json

object

**data**

required

Array\<object>

A connection a choice in the project may name: the company’s, or with `owner=me`, your own. Its `state` is `working` or `needs-reconnecting`: one that needs reconnecting may be chosen, and works again once it’s reconnected. A project admin reads all of a company one; a project member, only `connectionId` and `name`. You read all of your own.

object

**connectionId**

required

string format: uuid

**name**

required

Its label, else its account’s label (a connection made before connections had names).

string

**app**

The app’s entry id.

string

**accountLabel**

Its account’s label: an email address, a login.

string

**state**

`working`: runs can use it. `needs-reconnecting`: the app no longer accepts it; connect again. `removing`: a disconnect is under way. `removed`: gone.

string

Allowed values: working needs-reconnecting removing removed

**main**

Only ever `true`, with `owner=me`: your main connection of the app.

boolean

**nextCursor**

string

**hasMore**

required

boolean

##### Example

```json
{
  "data": [
    {
      "state": "working"
    }
  ]
}
```

### 400

No `projectId`, or one that is not a UUID; an `app` that is not an entry id; or an `owner` other than `me` (`bad-input`).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 401

Missing / malformed / expired / revoked bearer token.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 403

Not a member of the project (`permission-denied`).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 503

The database was too busy to answer in time (`database-busy`); `Retry-After` (whole seconds) says when to try again.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

## See also

- [Choose a connection](https://docs.kindgi.com/v0.5.0/guides/connections/choose-a-connection.md)
- [Kindgi 0.5.0](https://docs.kindgi.com/v0.5.0/releases/0.5.0.md)
- [Error code `bad-input`](https://docs.kindgi.com/v0.5.0/reference/errors.md#bad-input)
- [Error code `database-busy`](https://docs.kindgi.com/v0.5.0/reference/errors.md#database-busy)
- [Error code `permission-denied`](https://docs.kindgi.com/v0.5.0/reference/errors.md#permission-denied)
- [Every error code](https://docs.kindgi.com/v0.5.0/reference/errors.md)