Connectors

Get connectors.

get
Authorizations
Query parameters
start-indexinteger · int32Optional

an integer specifying the starting point (beginning with 0) when paging through a list of entities

Default: 0
max-resultsinteger · int32 · max: 100Optional

the maximum number of results when paging through a list of entities.

Default: 50
Responses
200
The connectors
application/json
get
GET /api/connectors HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

The connectors

[
  {
    "id": "text",
    "type": "jira",
    "name": "text",
    "createdAt": "2025-07-08T11:51:57.447Z",
    "updatedAt": "2025-07-08T11:51:57.447Z",
    "params": {
      "apiKey": "text"
    }
  }
]

Create a new connector.

post
Authorizations
Body
idstringOptional
typestring · enumRequiredPossible values:
namestringRequired
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
paramsone ofOptional
or
or
or
or
objectOptional
or
or
or
or
or
or
or
or
or
or
or
Responses
200
The newly created connector
application/json
post
POST /api/connectors HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "id": "text",
  "type": "jira",
  "name": "text",
  "createdAt": "2025-07-08T11:51:57.447Z",
  "updatedAt": "2025-07-08T11:51:57.447Z",
  "params": {
    "apiKey": "text"
  }
}
200

The newly created connector

{
  "id": "text",
  "type": "jira",
  "name": "text",
  "createdAt": "2025-07-08T11:51:57.447Z",
  "updatedAt": "2025-07-08T11:51:57.447Z",
  "params": {
    "apiKey": "text"
  }
}

Get a specific connector.

get
Authorizations
Path parameters
idstringRequired

entity ID

Responses
200
The requested connector
application/json
get
GET /api/connectors/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

The requested connector

{
  "id": "text",
  "type": "jira",
  "name": "text",
  "createdAt": "2025-07-08T11:51:57.447Z",
  "updatedAt": "2025-07-08T11:51:57.447Z",
  "params": {
    "apiKey": "text"
  }
}

Update the specific connector. (note: type cannot be changed)

put
Authorizations
Path parameters
idstringRequired

entity ID

Body
idstringOptional
typestring · enumRequiredPossible values:
namestringRequired
createdAtstring · date-timeOptional
updatedAtstring · date-timeOptional
paramsone ofOptional
or
or
or
or
objectOptional
or
or
or
or
or
or
or
or
or
or
or
Responses
200
The updated connector
application/json
put
PUT /api/connectors/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "id": "text",
  "type": "jira",
  "name": "text",
  "createdAt": "2025-07-08T11:51:57.447Z",
  "updatedAt": "2025-07-08T11:51:57.447Z",
  "params": {
    "apiKey": "text"
  }
}
200

The updated connector

{
  "id": "text",
  "type": "jira",
  "name": "text",
  "createdAt": "2025-07-08T11:51:57.447Z",
  "updatedAt": "2025-07-08T11:51:57.447Z",
  "params": {
    "apiKey": "text"
  }
}

Remove a specific connector.

delete
Authorizations
Path parameters
idstringRequired

entity ID

Responses
204
Empty body delete response
delete
DELETE /api/connectors/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
204

Empty body delete response

No content

Was this helpful?