Skip to main content
POST
/
v1
/
connector-accounts
Create connector account
curl --request POST \
  --url https://api.openworklabs.com/v1/connector-accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectorType": "github",
  "remoteId": "<string>",
  "displayName": "<string>",
  "externalAccountRef": "<string>",
  "metadata": {}
}
'
{
  "ok": true,
  "item": {
    "id": "<string>",
    "organizationId": "<string>",
    "connectorType": "github",
    "remoteId": "<string>",
    "externalAccountRef": "<string>",
    "displayName": "<string>",
    "status": "active",
    "createdByOrgMembershipId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Body

application/json
connectorType
enum<string>
required
Available options:
github
remoteId
string
required
Required string length: 1 - 255
displayName
string
required
Required string length: 1 - 255
externalAccountRef
string | null
Required string length: 1 - 255
metadata
object

Response

Connector account created successfully.

ok
boolean
required
item
object
required