How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Fresnel Software Global Configuration API

The Global Configuration API from Fresnel Software — 10 operation(s) for global configuration.

Fresnel Software Global Configuration API is one of 70 APIs that Fresnel Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Global Configuration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 22 operations across 10 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{workspace}.api.vitruvi.cc.

22 operations 10 paths 15 schemas 3 DELETE8 GET3 PATCH5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://{workspace}.api.vitruvi.cc
Authentication
HTTP Basic, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Fresnel Software Global Configuration API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (jwtAuth). It accepts HTTP bearer tokens (tokenAuth).

  • jwtAuth — Token-based authentication with required prefix "JWT"

Paths & Operations 22

Across 10 paths, the API surfaces 22 operations — 3 DELETE, 8 GET, 3 PATCH, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Global Configuration 22
GET
/api/v1/companies/
List Companies
list_companies 11 params → 200
POST
/api/v1/companies/
Create Company
create_companies body → 201
GET
/api/v1/companies/{id}/
Retrieve Company
get_companies 1 param → 200
PUT
/api/v1/companies/{id}/
Update Company
update_companies 1 param body → 200
PATCH
/api/v1/companies/{id}/
Partial Update Company
patch_companies 1 param body → 200
DELETE
/api/v1/companies/{id}/
Delete Company
delete_companies 1 param → 204
GET
/api/v1/companies/{id}/download_logo/
Get Company Logo
get_company_logo 1 param → 200
GET
/api/v1/materials/
List Materials
list_materials 9 params → 200
POST
/api/v1/materials/
Create Material
create_material body → 201
POST
/api/v1/materials/batch_delete/
Batch Delete Material
batch_delete_material body → 200
POST
/api/v1/materials/batch_update/
Batch Update Material
batch_update_material body → 200
GET
/api/v1/materials/{id}/
Get Material
get_material 1 param → 200
PUT
/api/v1/materials/{id}/
Update Material
update_material 1 param body → 200
PATCH
/api/v1/materials/{id}/
Patch Material
patch_material 1 param body → 200
DELETE
/api/v1/materials/{id}/
Delete Material
delete_material 1 param → 204
GET
/api/v1/subcontractors/
List Companies
list_subcontractors 11 params → 200
POST
/api/v1/subcontractors/
Create Company
create_subcontractors body → 201
GET
/api/v1/subcontractors/{id}/
Retrieve Company
get_subcontractors 1 param → 200
PUT
/api/v1/subcontractors/{id}/
Update Company
update_subcontractors 1 param body → 200
PATCH
/api/v1/subcontractors/{id}/
Partial Update Company
patch_subcontractors 1 param body → 200
DELETE
/api/v1/subcontractors/{id}/
Delete Company
delete_subcontractors 1 param → 204
GET
/api/v1/subcontractors/{id}/download_logo/
Get Company Logo
get_company_logo_2 1 param → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PatchedCompany (33 properties), Company (33 properties), PatchedMaterial (19 properties), Material (19 properties). Each schema is shown below with its type and property counts.

BlankEnum
PaginatedCompanyList
object
4 properties
Company
object
33 properties 8 required
CompanyTypeEnum
string
NO - NO EPC - EPC SC - SC
Material
object
19 properties 10 required
CustomField
object
16 properties 15 required
PatchedCompany
object
33 properties
DataFormatEnum
string
url - url multiline - multiline
ChildCustomFieldSettings
object
13 properties 6 required
CustomFieldDataTypeEnum
string
boolean - boolean date - date datetime - datetime string - string number - number list - list entitylist - entitylist file - file table - table signature - sig…
PatchedMaterial
object
19 properties
CustomFieldListOption
object
7 properties 5 required
UserTierEnum
string
Office User - Office User Field User - Field User Read Only - Read Only Support - Support Service - Service No Login - No Login
PaginatedMaterialList
object
4 properties
BatchDeleteIds
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vitruvi-global-configuration-api-openapi.yml Raw ↑

Other APIs Fresnel Software publishes across the network.

Vitruvi Platform
Fresnel Software Aggregation API
Fresnel Software Ai agent API
Fresnel Software Async events API
Fresnel Software Auth API
Fresnel Software Conditional custom field overrides API
Fresnel Software Configuration library API
Fresnel Software Content types API
Fresnel Software Crew categories API
Fresnel Software Crews API
Fresnel Software Crews with resources API
Fresnel Software Custom field categories API
Where this information came from

This is an independent, third-party profile of Fresnel Software Global Configuration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.