GoSmarter API Gateway

Admin

Endpointhttps://api.gosmarter.ai

Get system info

GET

https://api.gosmarter.ai

/api/goadmin/system-info

Retrieves system information (admin only)

Get system info › Responses

System information retrieved successfully

GET/api/goadmin/system-info

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/system-info

shell

Example Responses

{}

json

application/json

List all companies

GET

https://api.gosmarter.ai

/api/goadmin/companies

Retrieves all companies in the system (admin only)

List all companies › Responses

Companies retrieved successfully

GET/api/goadmin/companies

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/companies

shell

Example Responses

{}

json

application/json

List company entitlements

GET

https://api.gosmarter.ai

/api/goadmin/companies/{companyId}/entitlements

Retrieves all entitlements for a specific company (admin only)

List company entitlements › path Parameters

companyId

string · uuid · required

The company ID

List company entitlements › Responses

List of company entitlements

object[]

featureId

integer · int32

featureKey

string

featureName

string

description

string

category

string

requiresUnlock

boolean

displayOrder

integer · int32

isEnabled

boolean

unlockedAt

string · date-time

expiresAt

string · date-time

notes

string

hasAccess

boolean

GET/api/goadmin/companies/{companyId}/entitlements

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/companies/:companyId/entitlements

shell

Example Responses

[
  {
    "featureId": 0,
    "featureKey": "featureKey",
    "featureName": "featureName",
    "description": "description",
    "category": "category",
    "requiresUnlock": true,
    "displayOrder": 0,
    "isEnabled": true,
    "unlockedAt": "2024-08-25T15:00:00Z",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notes": "notes",
    "hasAccess": true
  }
]

json

application/json

Grant feature entitlement

POST

https://api.gosmarter.ai

/api/goadmin/companies/{companyId}/entitlements

Grants a feature entitlement to a company (admin only)

Grant feature entitlement › path Parameters

companyId

string · uuid · required

The company ID

Grant feature entitlement › Request Body

featureId

integer · int32

expiresAt

string · date-time

notes

string

Grant feature entitlement › Responses

Entitlement granted successfully

POST/api/goadmin/companies/{companyId}/entitlements

curl --request POST \
  --url https://api.gosmarter.ai/api/goadmin/companies/:companyId/entitlements \
  --header 'Content-Type: application/json' \
  --data '
{
  "featureId": 0,
  "expiresAt": "2024-08-25T15:00:00Z",
  "notes": "notes"
}
'

shell

Example Request Body

{
  "featureId": 0,
  "expiresAt": "2024-08-25T15:00:00Z",
  "notes": "notes"
}

json

Example Responses

{}

json

application/json

List all features

GET

https://api.gosmarter.ai

/api/goadmin/features

Retrieves all available features in the platform (admin only)

List all features › Responses

List of all features

object[]

featureId

integer · int32

featureName

string

featureKey

string

description

string

category

string

requiresUnlock

boolean

displayOrder

integer · int32

GET/api/goadmin/features

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/features

shell

Example Responses

[
  {
    "featureId": 0,
    "featureName": "featureName",
    "featureKey": "featureKey",
    "description": "description",
    "category": "category",
    "requiresUnlock": true,
    "displayOrder": 0
  }
]

json

application/json

Revoke feature entitlement

POST

https://api.gosmarter.ai

/api/goadmin/companies/{companyId}/entitlements/{featureId}/revoke

Revokes a feature entitlement from a company (admin only)

Revoke feature entitlement › path Parameters

companyId

string · uuid · required

The company ID

featureId

integer · int32 · required

The feature ID to revoke

Revoke feature entitlement › Responses

Entitlement revoked successfully

POST/api/goadmin/companies/{companyId}/entitlements/{featureId}/revoke

curl --request POST \
  --url https://api.gosmarter.ai/api/goadmin/companies/:companyId/entitlements/:featureId/revoke

shell

Example Responses

{}

json

application/json

Company Documentation

GoSmarter API Gateway

Admin

Endpointhttps://api.gosmarter.ai

Get system info

GET

https://api.gosmarter.ai

/api/goadmin/system-info

Retrieves system information (admin only)

Get system info › Responses

System information retrieved successfully

GET/api/goadmin/system-info

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/system-info

shell

Example Responses

{}

json

application/json

List all companies

GET

https://api.gosmarter.ai

/api/goadmin/companies

Retrieves all companies in the system (admin only)

List all companies › Responses

Companies retrieved successfully

GET/api/goadmin/companies

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/companies

shell

Example Responses

{}

json

application/json

List company entitlements

GET

https://api.gosmarter.ai

/api/goadmin/companies/{companyId}/entitlements

Retrieves all entitlements for a specific company (admin only)

List company entitlements › path Parameters

companyId

string · uuid · required

The company ID

List company entitlements › Responses

List of company entitlements

object[]

featureId

integer · int32

featureKey

string

featureName

string

description

string

category

string

requiresUnlock

boolean

displayOrder

integer · int32

isEnabled

boolean

unlockedAt

string · date-time

expiresAt

string · date-time

notes

string

hasAccess

boolean

GET/api/goadmin/companies/{companyId}/entitlements

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/companies/:companyId/entitlements

shell

Example Responses

[
  {
    "featureId": 0,
    "featureKey": "featureKey",
    "featureName": "featureName",
    "description": "description",
    "category": "category",
    "requiresUnlock": true,
    "displayOrder": 0,
    "isEnabled": true,
    "unlockedAt": "2024-08-25T15:00:00Z",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notes": "notes",
    "hasAccess": true
  }
]

json

application/json

Grant feature entitlement

POST

https://api.gosmarter.ai

/api/goadmin/companies/{companyId}/entitlements

Grants a feature entitlement to a company (admin only)

Grant feature entitlement › path Parameters

companyId

string · uuid · required

The company ID

Grant feature entitlement › Request Body

featureId

integer · int32

expiresAt

string · date-time

notes

string

Grant feature entitlement › Responses

Entitlement granted successfully

POST/api/goadmin/companies/{companyId}/entitlements

curl --request POST \
  --url https://api.gosmarter.ai/api/goadmin/companies/:companyId/entitlements \
  --header 'Content-Type: application/json' \
  --data '
{
  "featureId": 0,
  "expiresAt": "2024-08-25T15:00:00Z",
  "notes": "notes"
}
'

shell

Example Request Body

{
  "featureId": 0,
  "expiresAt": "2024-08-25T15:00:00Z",
  "notes": "notes"
}

json

Example Responses

{}

json

application/json

List all features

GET

https://api.gosmarter.ai

/api/goadmin/features

Retrieves all available features in the platform (admin only)

List all features › Responses

List of all features

object[]

featureId

integer · int32

featureName

string

featureKey

string

description

string

category

string

requiresUnlock

boolean

displayOrder

integer · int32

GET/api/goadmin/features

curl --request GET \
  --url https://api.gosmarter.ai/api/goadmin/features

shell

Example Responses

[
  {
    "featureId": 0,
    "featureName": "featureName",
    "featureKey": "featureKey",
    "description": "description",
    "category": "category",
    "requiresUnlock": true,
    "displayOrder": 0
  }
]

json

application/json

Revoke feature entitlement

POST

https://api.gosmarter.ai

/api/goadmin/companies/{companyId}/entitlements/{featureId}/revoke

Revokes a feature entitlement from a company (admin only)

Revoke feature entitlement › path Parameters

companyId

string · uuid · required

The company ID

featureId

integer · int32 · required

The feature ID to revoke

Revoke feature entitlement › Responses

Entitlement revoked successfully

POST/api/goadmin/companies/{companyId}/entitlements/{featureId}/revoke

curl --request POST \
  --url https://api.gosmarter.ai/api/goadmin/companies/:companyId/entitlements/:featureId/revoke

shell

Example Responses

{}

json

application/json

Company Documentation