GoSmarter API Gateway

User

Endpointhttps://api.gosmarter.ai

Check user sync status

POST

https://api.gosmarter.ai

/api/user/{userId}/sync-check

Compares Entra ID values against database. Returns DB values (or nulls) and isSynced flag.

Check user sync status › path Parameters

userId

string · uuid · required

The unique identifier of the user (must match authenticated user)

Check user sync status › Request Body

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

Check user sync status › Responses

Sync status and database values returned

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

isSynced

boolean

POST/api/user/{userId}/sync-check

curl --request POST \
  --url https://api.gosmarter.ai/api/user/:userId/sync-check \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}
'

shell

Example Request Body

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}

json

Example Responses

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true,
  "isSynced": true
}

json

application/json

Update user profile in database

PUT

https://api.gosmarter.ai

/api/user/{userId}

Updates a user's profile information in local database. Frontend updates Entra ID separately.

Update user profile in database › path Parameters

userId

string · uuid · required

The unique identifier of the user to update (must match authenticated user)

Update user profile in database › Request Body

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

Update user profile in database › Responses

User profile update accepted

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

isSynced

boolean

PUT/api/user/{userId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/user/:userId \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}
'

shell

Example Request Body

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}

json

Example Responses

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true,
  "isSynced": true
}

json

application/json

List companies by IDs for a user

POST

https://api.gosmarter.ai

/api/user/{userId}/companies/list

Retrieves multiple companies in a single query based on an array of company IDs. Used during authentication to fetch all companies a user has access to. The userId in the route must match the authenticated user.

List companies by IDs for a user › path Parameters

userId

string · uuid · required

The user ID - must match the authenticated user

List companies by IDs for a user › Request Body

string[]

List companies by IDs for a user › Responses

Companies retrieved successfully

object[]

createdAt

string · date-time

updatedAt

string · date-time

companyId

string · uuid

companyName

string

address

string

POST/api/user/{userId}/companies/list

curl --request POST \
  --url https://api.gosmarter.ai/api/user/:userId/companies/list \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

shell

Example Request Body

[
  "string"
]

json

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "companyName": "companyName",
    "address": "address"
  }
]

json

application/json

System ScrapLog

GoSmarter API Gateway

User

Endpointhttps://api.gosmarter.ai

Check user sync status

POST

https://api.gosmarter.ai

/api/user/{userId}/sync-check

Compares Entra ID values against database. Returns DB values (or nulls) and isSynced flag.

Check user sync status › path Parameters

userId

string · uuid · required

The unique identifier of the user (must match authenticated user)

Check user sync status › Request Body

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

Check user sync status › Responses

Sync status and database values returned

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

isSynced

boolean

POST/api/user/{userId}/sync-check

curl --request POST \
  --url https://api.gosmarter.ai/api/user/:userId/sync-check \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}
'

shell

Example Request Body

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}

json

Example Responses

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true,
  "isSynced": true
}

json

application/json

Update user profile in database

PUT

https://api.gosmarter.ai

/api/user/{userId}

Updates a user's profile information in local database. Frontend updates Entra ID separately.

Update user profile in database › path Parameters

userId

string · uuid · required

The unique identifier of the user to update (must match authenticated user)

Update user profile in database › Request Body

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

Update user profile in database › Responses

User profile update accepted

userId

string · uuid

firstName

string

lastName

string

tutorialMode

boolean

isSynced

boolean

PUT/api/user/{userId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/user/:userId \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}
'

shell

Example Request Body

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true
}

json

Example Responses

{
  "userId": "00000000-0000-0000-0000-000000000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "tutorialMode": true,
  "isSynced": true
}

json

application/json

List companies by IDs for a user

POST

https://api.gosmarter.ai

/api/user/{userId}/companies/list

List companies by IDs for a user › path Parameters

userId

string · uuid · required

The user ID - must match the authenticated user

List companies by IDs for a user › Request Body

string[]

List companies by IDs for a user › Responses

Companies retrieved successfully

object[]

createdAt

string · date-time

updatedAt

string · date-time

companyId

string · uuid

companyName

string

address

string

POST/api/user/{userId}/companies/list

curl --request POST \
  --url https://api.gosmarter.ai/api/user/:userId/companies/list \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

shell

Example Request Body

[
  "string"
]

json

Example Responses

[
  {
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "companyName": "companyName",
    "address": "address"
  }
]

json

application/json

System ScrapLog