Alasco Custom Field Definition API
A **Custom Field Definition** describes a custom field - its name, type and which object it applies to (contract or project). Definitions are configured in Alasco and are read-only through this API.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/alasco-custom-field-definition-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: '## Introduction
You can use the Alasco API to integrate your application with Alasco.'
title: FinCon Custom Field Definition API
version: '1.0'
x-logo:
url: https://assets-global.website-files.com/656ef2eb27ad41897248f866/659eebec190ae7aaf4162f09_Logotype_Alasco_white_RGB%202.png
servers:
- url: https://api.alasco.de/fincon/v1
tags:
- description: A **Custom Field Definition** describes a custom field - its name, type and which object it applies to (contract or project). Definitions are configured in Alasco and are read-only through this API.
name: Custom Field Definition
paths:
/custom_field_definitions/:
get:
operationId: get_custom_field_definitions_custom_field_definitions__get
parameters:
- description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
in: query
name: cursor[position]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
List endpoint responses are paginated in the Alasco API. By calling the endpoint without the
pagination parameter you will receive the first page. If not all elements fit on one page there will
be a `next` link provided in the response''s `links` object. By calling this link you will receive
the next page.
'
title: Cursor[Position]
- description: '
You can filter on certain attributes by specifying them as a GET parameter along
with an operation, e.g. `filter[name.exact]=abc`.
Currently supported operations are:
* `exact`: Expects one value
* `contains`: Expects one value
* `in`: Expects one or multiple values
* `not_in`: Expects one or multiple values
The following attributes support filtering:
| **Attribute** | `exact` | `contains` | `in` | `not_in` |
| :--- | :---: | :---: | :---: | :---: |
| `id` | | | x | x |
| `name` | x | x | | |
| `description` | x | x | | |
| `export_name` | x | x | | |
| `field_type` | | | x | x |
| `unit` | | | x | x |
| `object_type` | | | x | x |
'
in: query
name: filter[attribute.operation]
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: '
You can filter on certain attributes by specifying them as a GET parameter along
with an operation, e.g. `filter[name.exact]=abc`.
Currently supported operations are:
* `exact`: Expects one value
* `contains`: Expects one value
* `in`: Expects one or multiple values
* `not_in`: Expects one or multiple values
The following attributes support filtering:
| **Attribute** | `exact` | `contains` | `in` | `not_in` |
| :--- | :---: | :---: | :---: | :---: |
| `id` | | | x | x |
| `name` | x | x | | |
| `description` | x | x | | |
| `export_name` | x | x | | |
| `field_type` | | | x | x |
| `unit` | | | x | x |
| `object_type` | | | x | x |
'
title: Filter[Attribute.Operation]
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListResponse_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
API Token: []
summary: Get Custom Field Definitions
tags:
- Custom Field Definition
/custom_field_definitions/{id}/:
get:
operationId: get_custom_field_definition_details_custom_field_definitions__id___get
parameters:
- in: path
name: id
required: true
schema:
format: uuid
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Response_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
API Token: []
summary: Get Custom Field Definition Details
tags:
- Custom Field Definition
components:
schemas:
ValidationError:
properties:
ctx:
title: Context
type: object
input:
title: Input
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
Response_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__:
properties:
data:
anyOf:
- $ref: '#/components/schemas/Data_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__'
- type: 'null'
errors:
anyOf:
- items:
$ref: '#/components/schemas/Error'
type: array
- type: 'null'
title: Errors
included:
anyOf:
- items:
$ref: '#/components/schemas/Data_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__'
type: array
- type: 'null'
title: Included
links:
anyOf:
- additionalProperties:
anyOf:
- type: string
- type: 'null'
type: object
- type: 'null'
title: Links
title: 'Response[CustomFieldDefinitionAttributes, Literal[<ResourceType.CUSTOM_FIELD_DEFINITION: ''CUSTOM_FIELD_DEFINITION''>]]'
type: object
ListResponse_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__:
properties:
data:
items:
$ref: '#/components/schemas/Data_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__'
title: Data
type: array
errors:
anyOf:
- items:
$ref: '#/components/schemas/Error'
type: array
- type: 'null'
title: Errors
included:
anyOf:
- items:
$ref: '#/components/schemas/Data_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__'
type: array
- type: 'null'
title: Included
links:
anyOf:
- additionalProperties:
anyOf:
- type: string
- type: 'null'
type: object
- type: 'null'
description: '
Contains the pagination''s next link if results don''t fit on one page.
'
title: Links
required:
- data
title: 'ListResponse[CustomFieldDefinitionAttributes, Literal[<ResourceType.CUSTOM_FIELD_DEFINITION: ''CUSTOM_FIELD_DEFINITION''>]]'
type: object
CustomFieldDefinitionAttributes:
properties:
description:
description: '**Description** · **Beschreibung**'
title: Description
type: string
export_name:
description: '**Export name** · **Exportname**'
title: Export Name
type: string
field_type:
$ref: '#/components/schemas/alasco__public_api__fincon__web__v1__schemas__custom_field_definition__CustomFieldType'
description: '**Field type** · **Typ**'
examples:
- INTEGER
name:
description: '**Name** · **Name**'
title: Name
type: string
object_type:
$ref: '#/components/schemas/CustomFieldObjectType'
description: '**Object type** · **Objekttyp**
Available values / Verfügbare Werte:
| Value | English | Deutsch |
| --- | --- | --- |
| `CONTRACT` | Contract | Auftrag |
| `PROJECT` | Project | Projekt |'
examples:
- CONTRACT
unit:
$ref: '#/components/schemas/CustomFieldUnit'
description: '**Unit** · **Einheit**'
examples:
- NO_UNIT
required:
- name
- export_name
- field_type
- unit
- description
- object_type
title: CustomFieldDefinitionAttributes
type: object
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
alasco__public_api__fincon__web__v1__schemas__custom_field_definition__CustomFieldType:
enum:
- TEXT
- INTEGER
- DECIMAL
- DATE
- MONEY
- SELECT
- MULTISELECT
- BOOLEAN
title: CustomFieldType
type: string
Error:
properties:
detail:
anyOf:
- type: string
- type: 'null'
title: Detail
source:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Source
status:
anyOf:
- type: string
- type: 'null'
title: Status
title:
anyOf:
- type: string
- type: 'null'
title: Title
title: Error
type: object
CustomFieldObjectType:
enum:
- CONTRACT
- PROJECT
title: CustomFieldObjectType
type: string
Data_CustomFieldDefinitionAttributes_Literal_CUSTOM_FIELD_DEFINITION__:
properties:
attributes:
$ref: '#/components/schemas/CustomFieldDefinitionAttributes'
id:
format: uuid
title: Id
type: string
relationships:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
description: '
Contains links to related objects.
'
title: Relationships
type:
const: CUSTOM_FIELD_DEFINITION
title: Type
type: string
required:
- id
- type
- attributes
title: 'Data[CustomFieldDefinitionAttributes, Literal[<ResourceType.CUSTOM_FIELD_DEFINITION: ''CUSTOM_FIELD_DEFINITION''>]]'
type: object
CustomFieldUnit:
enum:
- NO_UNIT
- CURRENCY
- LENGTH
- AREA
- VOLUME
- PERCENT
title: CustomFieldUnit
type: string
securitySchemes:
API_Key:
description: '
The Alasco API uses a combination of API keys and API tokens to authenticate requests. The API key
needs to be sent in a header field called `X-API-KEY`.
'
in: header
name: X-API-KEY
type: apiKey
API_Token:
description: '
In addition to an API key, one has to specify an API token. There can be one or more tokens in use
for the same API key. The token needs to be sent in a header field called `X-API-TOKEN`.
Right now, it''s not possible to create API keys and API tokens from within Alasco.
If you are interested in using the Alasco API, please reach out to the
[support team](mailto:support@alasco.de). They will assist you in generating a key and token pair.
'
in: header
name: X-API-TOKEN
type: apiKey
x-tagGroups:
- name: Core API
tags:
- Change Order
- Change Order Document
- Contact
- Contract
- Contract Document
- Contract Unit
- Contracting Entity
- Contractor
- Cost Element
- Cost Element Tree Template
- Custom Field
- Custom Field Definition
- Budget Shift
- Invoice
- Invoice Document
- Invoice Tag
- Project
- Property
- name: Reporting API
tags:
- Contract Financials
- Contract Unit Financials
- Cash Outflow Cost Element View
- Cost Element Financials
- Cost Element Contract Financials
- Cost Element Contract Unit Financials
- Project Financials
- Outright Sale
- Rent Unit
- Sales Unit