Connectors
Authorizations
Query parameters
start-indexinteger · int32OptionalDefault:
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
max-resultsinteger · int32 · max: 100OptionalDefault:
the maximum number of results when paging through a list of entities.
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"
}
}
]
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
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"
}
}
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"
}
}
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
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"
}
}
Was this helpful?