List connections

GET

/meta/v1/connections

Authorizations

• bearerAuth

Parameters

Query Parameters

after

Opaque cursor: pass the next_cursor of the previous page back unchanged. With sort it must come from a page with the same sort and order; without sort it is the id of the last record.

string

Opaque cursor: pass the next_cursor of the previous page back unchanged. With sort it must come from a page with the same sort and order; without sort it is the id of the last record.

limit

integer

>= 1 <= 200

sort

Sort by id or created_at or updated_at or last_synced_at. Stored columns need only this list’s read scope; derived fields need the scopes that show them. null sorts as the lowest value: first in asc, last in desc. Ties break on id in the same direction. Newest first: sort=created_at&order=desc; for mail use sort=occurred_at&order=desc. Without sort the list is in ascending id order with UUID cursors. Paging is by keyset, not a snapshot: values can rise between pages (or fall), so a record may repeat in asc or be missed in desc. In descending mail date order, newly arrived mail ahead of the cursor is not seen; backfilled older mail behind it is. A complete walk uses the default order. An incremental walk also uses the default ascending id order. Mail created_at uses a temporary sort over the workspace’s rows; id is indexed and follows capture order.

string

Allowed values: id created_at updated_at last_synced_at

Sort by id or created_at or updated_at or last_synced_at. Stored columns need only this list’s read scope; derived fields need the scopes that show them. null sorts as the lowest value: first in asc, last in desc. Ties break on id in the same direction. Newest first: sort=created_at&order=desc; for mail use sort=occurred_at&order=desc. Without sort the list is in ascending id order with UUID cursors. Paging is by keyset, not a snapshot: values can rise between pages (or fall), so a record may repeat in asc or be missed in desc. In descending mail date order, newly arrived mail ahead of the cursor is not seen; backfilled older mail behind it is. A complete walk uses the default order. An incremental walk also uses the default ascending id order. Mail created_at uses a temporary sort over the workspace’s rows; id is indexed and follows capture order.

order

Sort direction: asc (default) or desc. Needs sort.

string

Allowed values: asc desc

Sort direction: asc (default) or desc. Needs sort.

Responses

200

Success

object

data

required

Array<object>

object

id

required

string format: uuid

organization_id

required

string format: uuid

provider

required

The provider of the account; google only for now.

string

Allowed values: google

account_id

required

The provider’s stable id for the account (Google’s sub). Not the address: an address can change.

string

identity_id

required

The own identity that is the connected mailbox’s address.

string format: uuid

owner_id

required

The user who owns the connection now; the person whose approval sends from it. A reconnect by another person moves it.

string format: uuid

status

required

Active works; reauth_required when the provider refused the stored grant; suspended when the owner is no longer admitted. A reconnect makes it active again.

string

Allowed values: active reauth_required suspended

granted_scopes

required

The OAuth scopes the person granted at the provider.

Array<string>

connected_at

required

When the connection was made or last reconnected.

string

created_by

required

string format: uuid

created_at

required

string

updated_at

required

string

last_synced_at

When the mailbox was last brought up to date; null until a sync has finished. Derived, read-only.

string | null

last_error_code

A short code for the last sync failure; null when the last run was fine or none ran. Derived, read-only.

string | null

next_cursor

required

Opaque cursor for the next page, or null at the end. Pass it back as after, with the same sort and order.

string | null