Public API for Customers, Partners, and Integrations
Onboarded Public API (0.0.1)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi
Onboarded Production Server
https://app.onboarded.com
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users
- Onboarded Production Serverhttps://app.onboarded.com/api/v1/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.onboarded.com/_mock/openapi/api/v1/users?email=string&page=string&per_page=string' \
-b __session=YOUR_API_KEY_HEREResponse
application/json
{ "data": [ { … } ], "total": 0, "current_page": 0, "per_page": 0, "total_pages": 0 }
Bodyapplication/jsonrequired
Any of:
Password must be at least 8 characters and contain uppercase, lowercase, and numbers.
>= 8 characters
string(minLength(8))>= 8 characters^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users
- Onboarded Production Serverhttps://app.onboarded.com/api/v1/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.onboarded.com/_mock/openapi/api/v1/users \
-H 'Content-Type: application/json' \
-b __session=YOUR_API_KEY_HERE \
-d '{
"email": "string",
"password": "stringst",
"email_verified": true,
"user_group_ids": [
"string"
]
}'Response
application/json
{ "id": "user_abc123def456", "email": "string", "created_at": "string", "updated_at": "string" }
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users/{user_id}
- Onboarded Production Serverhttps://app.onboarded.com/api/v1/users/{user_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.onboarded.com/_mock/openapi/api/v1/users/{user_id}' \
-b __session=YOUR_API_KEY_HEREResponse
application/json
{ "id": "user_abc123def456", "email": "string", "created_at": "string", "updated_at": "string" }
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users/{user_id}
- Onboarded Production Serverhttps://app.onboarded.com/api/v1/users/{user_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.onboarded.com/_mock/openapi/api/v1/users/{user_id}' \
-b __session=YOUR_API_KEY_HEREResponse
application/json
{ "id": "user_abc123def456", "email": "string", "created_at": "string", "updated_at": "string" }