GoSmarter Logo
GoSmarter API Gateway
GoSmarter API Gateway

Company

List companies accessible to the caller

POST
https://api.gosmarter.ai
/api/me/companies

Returns all companies accessible to the caller, from gosmarter.CompanyMembers (kept in sync from Clerk organizationMembership webhook events). Each company includes the caller's role ('admin' or 'member').

List companies accessible to the caller › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List companies accessible to the caller › Responses

Companies retrieved successfully

companyDto
createdAt
​string · date-time
updatedAt
​string · date-time
companyId
​string · uuid
companyName
​string
address
​string

Get company stamp for branded certificates

GET
https://api.gosmarter.ai
/api/company/{companyId}/certificate-settings/stamp

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

Get company stamp for branded certificates › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Get company stamp for branded certificates › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get company stamp for branded certificates › Responses

Stamp image streamed successfully (PNG or JPEG, depending on the stored file)

string · binary

Upload company stamp for branded certificates

PUT
https://api.gosmarter.ai
/api/company/{companyId}/certificate-settings/stamp

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

Upload company stamp for branded certificates › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Upload company stamp for branded certificates › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Upload company stamp for branded certificates › Request Body

Upload company stamp for branded certificates › Responses

Stamp uploaded; updated settings returned

companyCertificateSettingsDto
companyId
​string · uuid
logoStorageFileName
​string
stampStorageFileName
​string
stampText
​string
certificateContactName
​string
certificateContactEmail
​string
certificateContactPhone
​string
certificateFooterText
​string
companyRegistrationNumber
​string
createdAt
​string · date-time
updatedAt
​string · date-time

Delete company stamp for branded certificates

DELETE
https://api.gosmarter.ai
/api/company/{companyId}/certificate-settings/stamp

Removes the stored company stamp image and clears the accompanying stamp text. Idempotent; returns 200 even if no stamp was configured.

Delete company stamp for branded certificates › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Delete company stamp for branded certificates › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Delete company stamp for branded certificates › Responses

Stamp removed; updated settings returned

companyCertificateSettingsDto
companyId
​string · uuid
logoStorageFileName
​string
stampStorageFileName
​string
stampText
​string
certificateContactName
​string
certificateContactEmail
​string
certificateContactPhone
​string
certificateFooterText
​string
companyRegistrationNumber
​string
createdAt
​string · date-time
updatedAt
​string · date-time

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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get a company by ID › Responses

Company details retrieved successfully

companyDto
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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update a company › Request Body

coreCompanyDto
companyId
​string · uuid
companyName
​string
address
​string

Update a company › Responses

Company update accepted

coreCompanyDto
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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format 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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Upload company logo for branded certificates › Request Body

Upload company logo for branded certificates › Responses

Logo uploaded; updated settings returned

companyCertificateSettingsDto
companyId
​string · uuid
logoStorageFileName
​string
stampStorageFileName
​string
stampText
​string
certificateContactName
​string
certificateContactEmail
​string
certificateContactPhone
​string
certificateFooterText
​string
companyRegistrationNumber
​string
createdAt
​string · date-time
updatedAt
​string · date-time

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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get certificate branding settings › Responses

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

companyCertificateSettingsDto
companyId
​string · uuid
logoStorageFileName
​string
stampStorageFileName
​string
stampText
​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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update certificate branding settings › Request Body

updateCompanyCertificateSettingsRequest
stampText
​string
certificateContactName
​string
certificateContactEmail
​string
certificateContactPhone
​string
certificateFooterText
​string
companyRegistrationNumber
​string

Update certificate branding settings › Responses

Settings updated successfully

companyCertificateSettingsDto
companyId
​string · uuid
logoStorageFileName
​string
stampStorageFileName
​string
stampText
​string
certificateContactName
​string
certificateContactEmail
​string
certificateContactPhone
​string
certificateFooterText
​string
companyRegistrationNumber
​string
createdAt
​string · date-time
updatedAt
​string · date-time

Get company settings (Preview)

GET
https://api.gosmarter.ai
/api/company/{companyId}/settings

Preview: this endpoint may change or be removed without notice. Returns company-level settings that are not part of the company profile: currently kerfMm, the saw-blade width lost per cut that the optimiser applies.

Get company settings (Preview) › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Get company settings (Preview) › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get company settings (Preview) › Responses

The company's settings

companySettingsDto
companyId
​string · uuid
kerfMm
​number · double

Saw-blade width lost per cut, in mm (0 to 20, at most 2 decimal places).

Update company settings (Preview)

PUT
https://api.gosmarter.ai
/api/company/{companyId}/settings

Preview: this endpoint may change or be removed without notice. Company admins only. Sets kerfMm, the saw-blade width lost per cut (0 to 20 mm, rounded to 2 decimal places), which the next optimisation run applies. Does not change any other company field.

Update company settings (Preview) › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Update company settings (Preview) › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update company settings (Preview) › Request Body

updateCompanySettingsRequest
kerfMm
​number · double

Saw-blade width lost per cut, in mm. Required; 0 to 20 inclusive. Values with more than 2 decimal places are rounded to 2.

Update company settings (Preview) › Responses

Settings updated; the stored values

companySettingsDto
companyId
​string · uuid
kerfMm
​number · double

Saw-blade width lost per cut, in mm (0 to 20, at most 2 decimal places).

Get GS1 identifier settings

GET
https://api.gosmarter.ai
/api/company/{companyId}/gs1-settings

Returns the company's GS1 Company Prefix (null when none) and the resulting identifier namespace (GS1 or INTERNAL).

Get GS1 identifier settings › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Get GS1 identifier settings › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get GS1 identifier settings › Responses

The company's GS1 settings

gs1SettingsDto
companyId
​string · uuid
gs1CompanyPrefix
​string
identifierNamespace
​string

Set or clear the GS1 Company Prefix

PUT
https://api.gosmarter.ai
/api/company/{companyId}/gs1-settings

Company admins only. A 4-12 digit prefix switches new physical identifiers to the GS1 namespace; null/blank reverts to the internal namespace. Once GS1 identifiers have been issued under the current prefix it can no longer be changed or cleared (409). A prefix equal to, or overlapping, another company's prefix is rejected with 409.

Set or clear the GS1 Company Prefix › path Parameters

companyId
​string · uuid · required

The unique identifier of the company

Set or clear the GS1 Company Prefix › Headers

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Set or clear the GS1 Company Prefix › Request Body

updateGs1SettingsRequest
gs1CompanyPrefix
​string

Set or clear the GS1 Company Prefix › Responses

Settings updated

gs1SettingsDto
companyId
​string · uuid
gs1CompanyPrefix
​string
identifierNamespace
​string
deprecated

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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List email domains › Responses

Email domains retrieved successfully

companyEmailDomainDto
companyEmailDomainId
​string · uuid
companyId
​string · uuid
emailDomain
​string
active
​boolean
lastModifiedBy
​string · uuid
updatedAt
​string · date-time
deprecated

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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Add email domain › Request Body

createCompanyEmailDomainRequest
emailDomain
​string

Add email domain › Responses

Authentication required

errorResponse
statusCode
​integer · int32

HTTP status code e.g. 404, 403, 500

message
​string

Human-readable error message explaining the failure

details
​string

Detailed error information

timestamp
​string · date-time

ISO 8601 timestamp when the error occurred (UTC)

traceId
​string

Correlation / trace identifier for diagnostics

deprecated

Remove email domain

DELETE
https://api.gosmarter.ai
/api/company/{companyId}/email-domains/{domainId}

Withdrawn — always returns 410 Gone. Previously soft-deleted an email domain registration from the company.

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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Remove email domain › Responses

Authentication required

errorResponse
statusCode
​integer · int32

HTTP status code e.g. 404, 403, 500

message
​string

Human-readable error message explaining the failure

details
​string

Detailed error information

timestamp
​string · date-time

ISO 8601 timestamp when the error occurred (UTC)

traceId
​string

Correlation / trace identifier for diagnostics

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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get email domain change history › Responses

Audit history returned successfully

auditEventDto
changedAt
​string · date-time
changedById
​string · uuid
changedByName
​string
changeType
​string
entityType
​string
entityLabel
​string
deprecated

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

GoSmarter-Api-Key
​string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Restore email domain › Responses

Authentication required

errorResponse
statusCode
​integer · int32

HTTP status code e.g. 404, 403, 500

message
​string

Human-readable error message explaining the failure

details
​string

Detailed error information

timestamp
​string · date-time

ISO 8601 timestamp when the error occurred (UTC)

traceId
​string

Correlation / trace identifier for diagnostics

Organisations