pydo.connections.list()

Generated on 1 Oct 2026 from pydo version v0.43.0

Usage

client.connections.list(
    provider=None,
    user_id=None,
    status=None,
    sort=None,
    sort_direction=None,
    page=1,
    per_page=20,
)
Returns JSONRaises HttpResponseError

Description

Returns the connections you can see, excluding revoked ones. Offset-paged with page and per_page; filter by provider, user_id, and status.

Parameters

provider string optional

Optional provider slug, matched exactly.

user_id string optional

Optional substring of user_id. It must use the user_id alphabet, [A-Za-z0-9._-].

status string optional

pending|active|revoked|expired. List results always omit revoked connections, including when this filter is revoked.

One of: pending, active, expired

sort string optional

created_at, provider, user_id, or status. Defaults to provider, then user_id.

One of: created_at, provider, user_id, status

sort_direction string optional

asc (the default) or desc.

One of: asc, desc

page integer optional

1-based page number. Values below 1 are treated as 1.

Min: 1

Default: 1

per_page integer optional

Page size. Defaults to 20; values above 100 are capped at 100.

Min: 1

Max: 100

Default: 20

Pagination

This method returns paginated results. The response includes a links.pages object with URLs for navigating between pages. To retrieve the next page, parse the next URL and pass the page parameter:

from urllib.parse import urlparse, parse_qs

resp = client.connections.list()
pages = resp.get("links", {}).get("pages", {})

while "next" in pages:
    parsed = urlparse(pages["next"])
    page = int(parse_qs(parsed.query)["page"][0])
    resp = client.connections.list(page=page)
    pages = resp.get("links", {}).get("pages", {})

Response Example

Show Response Example
{
  "connections": [
    {
      "id": "39f9f768-a7f9-4c91-9557-3328c53dd054",
      "provider": "jira",
      "provider_display_name": "Jira",
      "user_id": "alice",
      "status": "active",
      "created_at": "2026-07-14T00:50:00Z",
      "updated_at": "2026-07-14T00:52:10Z",
      "revoked_at": null,
      "connection_parameters": {
        "site_url": "https://example.atlassian.net"
      },
      "credential_kind": "digitalocean_oauth",
      "credential_id": "",
      "network": null,
      "scopes": [
        "write:jira-work"
      ],
      "granted_at": "2026-07-14T00:52:10Z",
      "oauth": {
        "scopes": [
          "write:jira-work"
        ],
        "granted_at": "2026-07-14T00:52:10Z"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 1
  }
}

More Information

See /v2/action-gateway/connections in the API reference for additional detail on responses, headers, parameters, and more.

We can't find any results for your search.

Try using different keywords or simplifying your search terms.