Indox Auth API - OSLLM AI
stringstringstringbooleanbooleanintegerstringintegerintegerinteger · requiredinteger · requiredinteger · requiredinteger · required
string · requiredbooleaninteger · requiredstring · requiredstring · requiredstring · requiredboolean · requiredboolean · requiredstring · requiredstring · date-time · requiredstring · date-time · required
integer · requiredinteger · requiredstring · requiredstring · requiredstring · requiredboolean · requiredboolean · requiredstring · requiredstring · date-time · requiredstring · date-time · required
integer · requiredinteger · requiredstring · requiredstring · requiredstring · requiredboolean · requiredboolean · requiredstring · requiredstring · date-time · requiredstring · date-time · required
integer · required
integer · requiredstring · requiredinteger · requiredstring · requiredstring · requiredstring · requiredboolean · requiredboolean · requiredstring · requiredstring · date-time · requiredstring · date-time · required
integer · required
integer · requiredinteger · required
integer · requiredinteger · required
string
integer · requiredinteger · required
integer · required
integer · requiredstring · requiredstring · requiredstring · requiredstringstringstringboolean
integer · required
integer · required
integer · requiredinteger · requiredstring · requiredstring · requiredstring · requiredboolean · requiredboolean · requiredstring · requiredstring · date-time · requiredstring · date-time · required
List all businesses with filters. 25.1
GET
/auth/api/v1/business/
Paginated list of businesses with enhanced filters.
query Parameters
stateindustrystatusis_activeis_verifiedowner_idquerypageDefault: 1
page_sizeDefault: 20
List all businesses with filters. 25.1 › Responses
200
OK
counttotal_pagespagepage_sizerequired
required
object[] · required
Create a new business. 25.3
POST
/auth/api/v1/business/
Create a new business.
Create a new business. 25.3 › Request Body
nameis_activeDefault: true
Default: pending
Create a new business. 25.3 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
Get a single business by ID. 25.2
GET
/auth/api/v1/business/{business_id}/
Retrieve a single business by ID.
path Parameters
business_idGet a single business by ID. 25.2 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
Update a business. 25.4
PUT
/auth/api/v1/business/{business_id}/
Full or partial update of a business.
path Parameters
business_idUpdate a business. 25.4 › Request Body
required
required
required
required
required
required
required
required
required
required
required
required
required
required
Update a business. 25.4 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
Verify a business (admin only). 25.7
POST
/auth/api/v1/business/{business_id}/verify/
Verify a business (admin only).
path Parameters
business_idVerify a business (admin only). 25.7 › Request Body
Schema for business verification
is_verifiedobject[]
Default: []
Verify a business (admin only). 25.7 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
Update business status (admin only). 25.8
PUT
/auth/api/v1/business/{business_id}/status/
Update business status (admin only).
path Parameters
business_idquery Parameters
statusUpdate business status (admin only). 25.8 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
Invite a user to join a business. 25.9
POST
/auth/api/v1/businesses/{business_id}/users/invite/
Invite a user to join a business.
path Parameters
business_idInvite a user to join a business. 25.9 › Request Body
Schema for inviting users to a business
emailroleDefault: employee
is_primary_contactDefault: false
Invite a user to join a business. 25.9 › Responses
200
OK
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
Get a specific business user. 25.11
GET
/auth/api/v1/businesses/{business_id}/users/{user_id}/
Get a specific business user.
path Parameters
business_iduser_idGet a specific business user. 25.11 › Responses
200
OK
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
Update a business user's role and permissions. 25.12
PUT
/auth/api/v1/businesses/{business_id}/users/{user_id}/
Update a business user's role and permissions.
path Parameters
business_iduser_idUpdate a business user's role and permissions. 25.12 › Request Body
Schema for updating business user information
Update a business user's role and permissions. 25.12 › Responses
200
OK
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
Get all businesses for the current user. 25.16
GET
/auth/api/v1/users/businesses/
Get all businesses for the current user.
query Parameters
statusGet all businesses for the current user. 25.16 › Responses
200
OK
object[]
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
Update a user's role in a business. 25.17
PUT
/auth/api/v1/businesses/{business_id}/users/{user_id}/role/
Update a user's role in a business.
path Parameters
business_iduser_idUpdate a user's role in a business. 25.17 › Request Body
Schema for updating user roles within a business
user_idroleUpdate a user's role in a business. 25.17 › Responses
200
OK
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
Add existing user to a business. 25.18
POST
/auth/api/v1/businesses/{business_id}/users/create/
Create a new user and add them to a business.
path Parameters
business_idAdd existing user to a business. 25.18 › Request Body
Schema for creating business user relationships
user_idroleDefault: employee
is_primary_contactDefault: false
Add existing user to a business. 25.18 › Responses
200
OK
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
Create a new user and add them to a business. 25.19
POST
/auth/api/v1/businesses/{business_id}/users/create-new/
Create a completely new user and add them to a business.
path Parameters
business_idquery Parameters
usernameemailpasswordfirst_nameDefault:
last_nameDefault:
roleDefault: employee
object
is_primary_contactDefault: false
Create a new user and add them to a business. 25.19 › Responses
200
OK
Schema for returning business user information
idbusiness_iduser_iduser_uuidusernameemailfirst_namelast_namerolestatusis_primary_contactcreated_atupdated_atobject
Default: {}
Submit a business for verification. 25.21
POST
/auth/api/v1/businesses/{business_id}/submit-verification/
Submit a business for verification.
path Parameters
business_idSubmit a business for verification. 25.21 › Request Body
Schema for submitting business for verification
object[]
Default: []
Submit a business for verification. 25.21 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
Review a business verification (admin only). 25.22
POST
/auth/api/v1/businesses/{business_id}/review-verification/
Review a business verification (admin only).
path Parameters
business_idReview a business verification (admin only). 25.22 › Request Body
Schema for reviewing business verification
is_approvedReview a business verification (admin only). 25.22 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []
Get business verification status. 25.23
GET
/auth/api/v1/businesses/{business_id}/verification-status/
Get business verification status.
path Parameters
business_idGet business verification status. 25.23 › Responses
200
OK
idnamerequired
required
required
required
required
required
required
required
required
business_idrequired
required
required
statusis_activeis_verifiedverification_statuscreated_atupdated_atobject[]
Default: []
object[]
Default: []