/
ON
onboard
/
Onboard API - Complete Specification
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 5h ago · Updated 1d ago
Details
Filter operations
Activity
2
Assets
12
Billing
2
Bots
66
Comments
22
Communication Records
18
Conversations
14
Custom
14
Email
25
Forms
15
Hooks
12
Knowledge Base
23
Map
271
Platform
105
get
GET /
options
OPTIONS /
get
GET /getting-started-templates
options
OPTIONS /getting-started-templates
get
GET /getting-started-templates/{id}
options
OPTIONS /getting-started-templates/{id}
get
GET /companies
post
POST /companies
options
OPTIONS /companies
get
GET /companies/{id}
put
PUT /companies/{id}
delete
DELETE /companies/{id}
options
OPTIONS /companies/{id}
patch
PATCH /companies/{id}
get
GET /companies/{id}/members
post
POST /companies/{id}/members
options
OPTIONS /companies/{id}/members
get
GET /companies/{id}/members/{id}
put
PUT /companies/{id}/members/{id}
delete
DELETE /companies/{id}/members/{id}
options
OPTIONS /companies/{id}/members/{id}
patch
PATCH /companies/{id}/members/{id}
get
GET /companies/members
options
OPTIONS /companies/members
get
GET /customers
post
POST /customers
options
OPTIONS /customers
get
GET /customers/{id}
put
PUT /customers/{id}
delete
DELETE /customers/{id}
options
OPTIONS /customers/{id}
patch
PATCH /customers/{id}
get
GET /customers/{id}/members
post
POST /customers/{id}/members
options
OPTIONS /customers/{id}/members
get
GET /customers/{id}/members/{id}
put
PUT /customers/{id}/members/{id}
delete
DELETE /customers/{id}/members/{id}
options
OPTIONS /customers/{id}/members/{id}
patch
PATCH /customers/{id}/members/{id}
get
GET /company-members/{id}
put
PUT /company-members/{id}
delete
DELETE /company-members/{id}
options
OPTIONS /company-members/{id}
patch
PATCH /company-members/{id}
post
POST /member-requests
options
OPTIONS /member-requests
get
GET /members
post
POST /members
options
OPTIONS /members
get
GET /members/{id}
put
PUT /members/{id}
delete
DELETE /members/{id}
options
OPTIONS /members/{id}
patch
PATCH /members/{id}
post
POST /members/{id}/invite
options
OPTIONS /members/{id}/invite
get
GET /api-accounts
post
POST /api-accounts
options
OPTIONS /api-accounts
get
GET /api-accounts/{id}
put
PUT /api-accounts/{id}
delete
DELETE /api-accounts/{id}
options
OPTIONS /api-accounts/{id}
patch
PATCH /api-accounts/{id}
post
POST /webhooks/stripe
options
OPTIONS /webhooks/stripe
get
GET /account
put
PUT /account
options
OPTIONS /account
patch
PATCH /account
get
GET /account/address
put
PUT /account/address
options
OPTIONS /account/address
patch
PATCH /account/address
get
GET /defaults
options
OPTIONS /defaults
get
GET /onboarder-user/notifications
put
PUT /onboarder-user/notifications
options
OPTIONS /onboarder-user/notifications
patch
PATCH /onboarder-user/notifications
get
GET /onboardee-user/notifications
put
PUT /onboardee-user/notifications
options
OPTIONS /onboardee-user/notifications
patch
PATCH /onboardee-user/notifications
get
GET /action/complete-task
options
OPTIONS /action/complete-task
post
POST /sso/create
options
OPTIONS /sso/create
get
GET /sso
put
PUT /sso
delete
DELETE /sso
options
OPTIONS /sso
patch
PATCH /sso
get
GET /terms-acceptance
post
POST /terms-acceptance
options
OPTIONS /terms-acceptance
get
GET /roles
post
POST /roles
options
OPTIONS /roles
get
GET /roles/{id}
put
PUT /roles/{id}
delete
DELETE /roles/{id}
options
OPTIONS /roles/{id}
patch
PATCH /roles/{id}
Stats
46
Workflows
32
Platform
PATCH /api-accounts/{id}
PATCH operation for /api-accounts/{id}
patch
/api-accounts/{id}
Path parameters
id
string
required
Request body
APIMemberSerializer
required
id
integer
first_name
string
name
string
account_type
'admin'
|
'manager'
|
'lead'
|
'coordinator'
|
'onboarder'
|
'contributor'
|
'view_only'
|
'api'
is_active
string
created_at
string
date-time
modified_at
string
date-time
invited_at
string
date-time
status
'active'
|
'deactivated'
|
'invited'
|
'expired'
token
string
regenerate_token
boolean
Response
Successful response
APIMemberSerializer
required
id
integer
first_name
string
name
string
account_type
'admin'
|
'manager'
|
'lead'
|
'coordinator'
|
'onboarder'
|
'contributor'
|
'view_only'
|
'api'
is_active
string
created_at
string
date-time
modified_at
string
date-time
invited_at
string
date-time
status
'active'
|
'deactivated'
|
'invited'
|
'expired'
token
string
regenerate_token
boolean
Changes