Company

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 › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

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

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 › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

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

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 › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

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

Get company logo for branded certificates

GET

https://api.gosmarter.ai

/api/company/{companyId}/certificate-settings/logo

Streams the stored company logo. Returns 404 if no logo has been uploaded.

Get company logo for branded certificates › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get company logo for branded certificates › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get company logo for branded certificates › Responses

Logo image streamed successfully

string · binary

Upload company logo for branded certificates

PUT

https://api.gosmarter.ai

/api/company/{companyId}/certificate-settings/logo

Uploads a PNG or JPEG logo (max 2 MB) for use in branded Material Test Certificate PDFs. Overwrites any existing logo.

Upload company logo for branded certificates › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Upload company logo for branded certificates › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Upload company logo for branded certificates › Request Body

Upload company logo for branded certificates › Responses

Logo uploaded; updated settings returned

companyId

string · uuid

logoStorageFileName

string

certificateContactName

string

certificateContactEmail

string

certificateContactPhone

string

certificateFooterText

string

companyRegistrationNumber

string

createdAt

string · date-time

updatedAt

string · date-time

PUT/api/company/{companyId}/certificate-settings/logo

curl --request PUT \
  --url https://api.gosmarter.ai/api/company/:companyId/certificate-settings/logo \
  --header 'Authorization: <string>' \
  --header 'Content-Type: multipart/form-data'

shell

Example Request Body

{}

json

Example Responses

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "logoStorageFileName": "logoStorageFileName",
  "certificateContactName": "certificateContactName",
  "certificateContactEmail": "certificateContactEmail",
  "certificateContactPhone": "certificateContactPhone",
  "certificateFooterText": "certificateFooterText",
  "companyRegistrationNumber": "companyRegistrationNumber",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Get certificate branding settings

GET

https://api.gosmarter.ai

/api/company/{companyId}/certificate-settings

Returns the company's certificate branding configuration used when generating branded Material Test Certificate PDFs

Get certificate branding settings › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Get certificate branding settings › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get certificate branding settings › Responses

Certificate settings retrieved (all fields may be null if not yet configured)

companyId

string · uuid

logoStorageFileName

string

certificateContactName

string

certificateContactEmail

string

certificateContactPhone

string

certificateFooterText

string

companyRegistrationNumber

string

createdAt

string · date-time

updatedAt

string · date-time

Update certificate branding settings

PATCH

https://api.gosmarter.ai

/api/company/{companyId}/certificate-settings

Updates the company's certificate branding configuration. Logo is managed separately via the logo upload endpoint. This endpoint does not affect the stored logo. All fields should be supplied; pass null to clear a field.

Update certificate branding settings › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Update certificate branding settings › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update certificate branding settings › Request Body

certificateContactName

string

certificateContactEmail

string

certificateContactPhone

string

certificateFooterText

string

companyRegistrationNumber

string

Update certificate branding settings › Responses

Settings updated successfully

companyId

string · uuid

logoStorageFileName

string

certificateContactName

string

certificateContactEmail

string

certificateContactPhone

string

certificateFooterText

string

companyRegistrationNumber

string

createdAt

string · date-time

updatedAt

string · date-time

PATCH/api/company/{companyId}/certificate-settings

curl --request PATCH \
  --url https://api.gosmarter.ai/api/company/:companyId/certificate-settings \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "certificateContactName": "certificateContactName",
  "certificateContactEmail": "certificateContactEmail",
  "certificateContactPhone": "certificateContactPhone",
  "certificateFooterText": "certificateFooterText",
  "companyRegistrationNumber": "companyRegistrationNumber"
}
'

shell

Example Request Body

{
  "certificateContactName": "certificateContactName",
  "certificateContactEmail": "certificateContactEmail",
  "certificateContactPhone": "certificateContactPhone",
  "certificateFooterText": "certificateFooterText",
  "companyRegistrationNumber": "companyRegistrationNumber"
}

json

Example Responses

{
  "companyId": "00000000-0000-0000-0000-000000000000",
  "logoStorageFileName": "logoStorageFileName",
  "certificateContactName": "certificateContactName",
  "certificateContactEmail": "certificateContactEmail",
  "certificateContactPhone": "certificateContactPhone",
  "certificateFooterText": "certificateFooterText",
  "companyRegistrationNumber": "companyRegistrationNumber",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

List email domains

GET

https://api.gosmarter.ai

/api/company/{companyId}/email-domains

Returns all email domains registered for the company.

List email domains › path Parameters

companyId

string · uuid · required

The unique identifier of the company

List email domains › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List email domains › Responses

Email domains retrieved successfully

object[]

companyEmailDomainId

string · uuid

companyId

string · uuid

emailDomain

string

active

boolean

lastModifiedBy

string · uuid

updatedAt

string · date-time

Add email domain

POST

https://api.gosmarter.ai

/api/company/{companyId}/email-domains

Registers an email domain for the company. The same domain may be registered to multiple companies.

Add email domain › path Parameters

companyId

string · uuid · required

The unique identifier of the company

Add email domain › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Add email domain › Request Body

emailDomain

string

Add email domain › Responses

Domain registered successfully

companyEmailDomainId

string · uuid

companyId

string · uuid

emailDomain

string

active

boolean

lastModifiedBy

string · uuid

updatedAt

string · date-time

Remove email domain

DELETE

https://api.gosmarter.ai

/api/company/{companyId}/email-domains/{domainId}

Soft-deletes an email domain registration from the company. The domain can be restored via the restore endpoint.

Remove email domain › path Parameters

companyId

string · uuid · required

The unique identifier of the company

domainId

string · uuid · required

The unique identifier of the email domain entry to remove

Remove email domain › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Remove email domain › Responses

Domain soft-deleted successfully

No data returned

Get email domain change history

GET

https://api.gosmarter.ai

/api/company/{companyId}/email-domains/{domainId}/history

Returns the full temporal audit history for a company email domain, most recent changes first.

Get email domain change history › path Parameters

companyId

string · uuid · required

The unique identifier of the company

domainId

string · uuid · required

The unique identifier of the email domain entry

Get email domain change history › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get email domain change history › Responses

Audit history returned successfully

object[]

changedAt

string · date-time

changedById

string · uuid

changedByName

string

changeType

string

object[]

entityType

string

entityLabel

string

Restore email domain

POST

https://api.gosmarter.ai

/api/company/{companyId}/email-domains/{domainId}/restore

Restores a previously soft-deleted email domain registration for the company.

Restore email domain › path Parameters

companyId

string · uuid · required

The unique identifier of the company

domainId

string · uuid · required

The unique identifier of the email domain entry to restore

Restore email domain › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Restore email domain › Responses

Domain restored successfully

companyEmailDomainId

string · uuid

companyId

string · uuid

emailDomain

string

active

boolean

lastModifiedBy

string · uuid

updatedAt

string · date-time

User ScrapLog