Connectors, what the organization allows, and your own connections

GET

/connectors

const url = 'https://api.asklucy.eu/v1/connectors';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.asklucy.eu/v1/connectors \
  --header 'Authorization: Bearer <token>'

Every connector Lucy knows. available is false when this Lucy has no credentials for it; enabled and each app’s allowed are the organization’s choice; connection is yours (null if you have not connected). connection.apps are the apps Lucy can use now: what you consented to and the organization allows.

Authorizations

zitadel

Responses

200

application/json

object

data

required

Array<object>

object

required

string

name

required

string

description

required

string

available

required

This Lucy has credentials for the connector.

boolean

enabled

required

The organization turned it on.

boolean

apps

required

Array<object>

object

required

string

name

required

string

description

required

string

access

required

What the app lets Lucy do. Each of its tools has its own permission (ToolPermission).

string

Allowed values: read read_write

allowed

required

The organization allows this app.

boolean

connection

required

One of:

object
null

object

connected_by

One of:

object
null

object

required

Zitadel user ID.

string

name

required

string

email

string | null format: email

kind

service is a customer system’s Zitadel service user; agent is a service agent (its ID is the agt_ ID), the author of its runs’ messages.

string

Allowed values: person service agent

required

string

account

required

object

name

required

string | null

email

required

string | null

apps

required

The apps Lucy can use now, what the person consented to and the organization allows.

Array<string>

status

required

reauth: the person has to sign in at the service again.

string

Allowed values: active reauth

connected_at

required

string format: date-time

last_used_at

required

string | null format: date-time

connected_people

For admins (/org/connectors).

integer

next_cursor

required

string | null

Example

{
  "data": [
    {
      "id": "m365",
      "name": "Microsoft 365",
      "apps": [
        {
          "id": "calendar",
          "name": "Calendar",
          "access": "read"
        }
      ],
      "connection": {
        "connected_by": {
          "kind": "person"
        },
        "id": "con_8Qk2LmN4Rt7Wx1Yz3Aa5",
        "status": "active"
      }
    }
  ]
}

401

Missing, expired or invalid token.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.

403

The token is valid but lacks the role this needs.

application/problem+json

RFC 9457 problem details.

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

string

instance

string

request_id

string

quota

For quota-exceeded, the window that is used up.

object

window

required

string

Allowed values: five_hours week month

percent_used

required

number

<= 100

resets_at

required

Null for a rolling window that hasn’t started.

string | null format: date-time

limited_by

required

organization when the organization’s budget is closer to running out than the member’s own limit.

string

Allowed values: personal organization

request

One of:

object
null

A request as its member sees it, where they asked.

object

required

string

status

required

string

Allowed values: pending approved declined withdrawn

created_at

required

string format: date-time

decided_at

required

string | null format: date-time

note

required

What the admin who decided wrote back.

string | null

errors

Field-level problems (400 only).

Array<object>

object

field

required

JSON pointer into the request body.

string

message

required

string

Example

{
  "type": "https://docs.asklucy.eu/errors/answer-in-progress",
  "quota": {
    "window": "five_hours",
    "limited_by": "personal",
    "request": {
      "status": "pending"
    }
  }
}

Headers

X-Request-Id

string

Unique per request; quote it to support.