Components APIs
Onboarded API (0.0.1)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi/
https://app.onboarded.com/
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users
- https://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?page=1&per_page=20&email=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "data": [ { … } ], "total": 0 }
Bodyapplication/json
Body
When provided, please ensure password is at least 10 characters long and has a zxcvbn score greater than 3. We may also reject breached passwords (based on haveibeenpwned.com). Please handle errors for breached and weak password.
When false, user will be asked to receive a verification email upon login. Default is false.
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users
- https://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 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "user@example.com",
"password": "string",
"email_verified": true,
"user_group_ids": [
"string"
]
}'Response
application/json
{ "id": "string", "email": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users/{id}
- https://app.onboarded.com/api/v1/users/{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/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "id": "string", "email": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }
- Mock serverhttps://docs.onboarded.com/_mock/openapi/api/v1/users/{id}
- https://app.onboarded.com/api/v1/users/{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/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "id": "string", "email": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }