GoSmarter API Gateway

Company

Endpointhttps://api.gosmarter.ai

Get a company by ID

GET

https://api.gosmarter.ai

/api/company/{companyId}

Retrieves detailed information about a specific company

Get a company by ID › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

Get a company by ID › Responses

Company details retrieved successfully

createdAt

string · date-time

updatedAt

string · date-time

companyId

string · uuid

companyName

string

address

string

GET/api/company/{companyId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId

shell

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

Update a company

PUT

https://api.gosmarter.ai

/api/company/{companyId}

Updates an existing company's information

Update a company › path Parameters

companyId

string · uuid · required

The unique identifier of the company to update. Example: 11111111-2222-3333-4444-555555555555

Update a company › Request Body

companyId

string · uuid

companyName

string

address

string

Update a company › Responses

Company update accepted

companyId

string · uuid

companyName

string

address

string

PUT/api/company/{companyId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "companyName": "companyName",
  "address": "address"
}
'

shell

Example Request Body

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "companyName": "companyName",
  "address": "address"
}

json

Example Responses

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "companyName": "companyName",
  "address": "address"
}

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

Configuration Admin

GoSmarter API Gateway

Company

Endpointhttps://api.gosmarter.ai

Get a company by ID

GET

https://api.gosmarter.ai

/api/company/{companyId}

Retrieves detailed information about a specific company

Get a company by ID › path Parameters

companyId

string · uuid · required

The unique identifier of the company. Example: 11111111-2222-3333-4444-555555555555

Get a company by ID › Responses

Company details retrieved successfully

createdAt

string · date-time

updatedAt

string · date-time

companyId

string · uuid

companyName

string

address

string

GET/api/company/{companyId}

curl --request GET \
  --url https://api.gosmarter.ai/api/company/:companyId

shell

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

Update a company

PUT

https://api.gosmarter.ai

/api/company/{companyId}

Updates an existing company's information

Update a company › path Parameters

companyId

string · uuid · required

The unique identifier of the company to update. Example: 11111111-2222-3333-4444-555555555555

Update a company › Request Body

companyId

string · uuid

companyName

string

address

string

Update a company › Responses

Company update accepted

companyId

string · uuid

companyName

string

address

string

PUT/api/company/{companyId}

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "companyName": "companyName",
  "address": "address"
}
'

shell

Example Request Body

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "companyName": "companyName",
  "address": "address"
}

json

Example Responses

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "companyName": "companyName",
  "address": "address"
}

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

Configuration Admin