funtrade logo
API docs by Redocly

Funtrade REST API (0.9.0)

Download OpenAPI specification:

funtrade: hallo@funtrade.ch URL: https://www.funtrade.ch License: Apache 2.0 Terms of Service

API for Funtrade data manipulation

Release Info

This is a pre-release version. The current documentation was generated: 5.1.2026, 16:19:46

If you have any improvements or feedback for us, please do not hesitate to contact us at hallo@funtrade.ch

Authentication

API Key-based Authentication

The API requires an API key for authenticated requests. API keys currently must be requested by emailing your assigned customer support agent; include your account identifier and any required onboarding details in that request. After you receive the API key, include it on each request as an additional Header apikey: <your-key> or as an additional query parameter ?apikey=<urlencoded-your-key.

Header

curl -i "https://app.funtrade.ch/api/v1.0/crmapi/countries"  -H 'apikey: e1c9S833cbJEDSGZ6Vd0gbRcLadfsdfadsdfaFQxy6SCOxbg+IICDNGRbuz2c'

Query Parameter

curl -i "https://app.funtrade.ch/api/v1.0/crmapi/countries?apikey=e1c9S833cbJEDSGZ6Vd0gbRcLadfsdfadsdfaFQxy6SCOxbg%2BIICDNGRbuz2c"

Data Quality Checks

The current version of the api re-uses the existing funtrade user-interface's business logic. Thus, all data quality checks apply to the API too.

Here are some examples of such data quality / data validity checks (not complete):

  • ZIP exists
  • street exists at ZIP
  • street has a house number
  • house number exists in street

Special properties

When sending data to funtrade, funtrade will perform the data quality check and return an error containing an appropriate error code.

  • prefix qc_

    • the special properties prefixes with qc_ can be set if it is really required to overrule data-validity checks.

  • version

    • every API calls needs to carry the version field along.
    • it is used to check for concurrent manipulation.

How to handle data quality errors

For customer facing applications, it is recommended to re-ask the customer to check the data by showing an appropriate error message. In some rare cases, the implemented validity checks need to be overruled by setting the appropriate qc_ propertie in the request payload. As an example, if we want to save an address although it already exists with very similar data.

Concurrent mutation check

funtrade also performs a concurrent mutation check. In order to do so, every "writing" request to funtrade needs to carry the snapshot version along.

Webhooks

Funtrade supports a very flexible machanism to process webhooks.

In order to work, they need first to be defined in funtrade, then, an external system can drop any payload at the generated endpoint. The processing of the webhooks happens asynchronosuly. As long as the payload could be saved, the endpoint returns a 200 success code.

Example code:

curl --location 'https://app.funtrade.ch/webhooks/v1.0/data/brevo/webhook/batched' \
--header 'Content-Type: application/json' \
--header "apikey: $API_KEY" \
--data '{}'

funtrade CRM API

CRM API for Funtrade data manipulation V1

Retrieve all address types

Returns a list of all possible address types

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all attributes for persons

Returns a list of all possible attributes for persons

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all values from selection list for attribute

Returns a list of all possible values for attribute with selection list

Authorizations:
api_key_headerapi_key_query
path Parameters
code
required
string
Example: code-01

Unique identifier of the attribute

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all channels

Returns a list of all possible channels

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all country codes

Returns a list of all existing countries with country ISO-Code

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all person extra titles

Returns a list of all person extra titles

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all interaction states

Returns a list of all possible interaction state codes

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all languages

Returns a list of all possible application languages

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all organisational units

Returns a list of all possible organisational units

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search for people by various criteria

Returns a list of person objects matching the provided search parameters. At least one search parameter is recommended for meaningful results.

Authorizations:
api_key_headerapi_key_query
query Parameters
country
string
Example: country=Switzerland

Country name (e.g., 'Switzerland')

firstname
string
Example: firstname=John

First name of the person (partial or full match)

name
string
Example: name=Doe

Last name of the person (partial or full match)

street
string
Example: street=Main St.

Street name (partial or full match)

telecommunication
string
Example: telecommunication=peter.smith@gmail.com

Telecommunication (Telephone number, email, ...)

zip-city
string
Example: zip-city=8001 Zurich

Postal code and/or city name (e.g., '8000 Zurich')

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new person

Adds a new person record to the system. Person details are provided in the request body. Returns the created person's details and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
Request Body schema: application/json
required

Person details to create

birth_day
integer <int32>
birth_month
integer <int32>
birth_year
integer <int32>
company
string
contact_of
integer <int32>
first_name
string
is_standard_contact
boolean
language_code
string
last_name
string
note
string
organisational_unit_code
string
person_type
string
Enum: "PRIVATE" "CONTACT" "ORGANIZATION"
qc_correct_first_name
boolean
qc_correct_person
boolean
qc_create_attribute
integer <int32>
qc_create_household
boolean
salutation_code
string
sex_code
string
Enum: "SEXCODE_MALE" "SEXCODE_FEMALE" "SEXCODE_EMPTY"
title_code
string
version
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "birth_day": 0,
  • "birth_month": 0,
  • "birth_year": 0,
  • "company": "string",
  • "contact_of": 0,
  • "first_name": "string",
  • "is_standard_contact": true,
  • "language_code": "string",
  • "last_name": "string",
  • "note": "string",
  • "organisational_unit_code": "string",
  • "person_type": "PRIVATE",
  • "qc_correct_first_name": true,
  • "qc_correct_person": true,
  • "qc_create_attribute": 0,
  • "qc_create_household": true,
  • "salutation_code": "string",
  • "sex_code": "SEXCODE_MALE",
  • "title_code": "string",
  • "version": 1756369000008
}

Response samples

Content type
application/json
{
  • "birth_day": 0,
  • "birth_month": 0,
  • "birth_year": 0,
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "company": "string",
  • "contact_company": "string",
  • "contact_of": 0,
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "doublet_person_number": 0,
  • "extra_title": "string",
  • "extra_title_own": "string",
  • "first_name": "string",
  • "function": "string",
  • "function_own": "string",
  • "household": "string",
  • "id": 0,
  • "industry": "string",
  • "industry_code": "string",
  • "is_standard_contact": true,
  • "language_code": "string",
  • "last_name": "string",
  • "name_and_address": "string",
  • "note": "string",
  • "organisational_unit_code": "string",
  • "person_type": "PRIVATE",
  • "profession": "string",
  • "profession_code": "string",
  • "protection": "string",
  • "salutation_code": "string",
  • "sex_code": "SEXCODE_MALE",
  • "source": "string",
  • "title_code": "string",
  • "version": 1756369000008
}

Retrieve a person by ID

Returns a single person object based on the provided unique identifier.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 123

Unique ID of the person to retrieve

Responses

Response samples

Content type
application/json
{
  • "birth_day": 0,
  • "birth_month": 0,
  • "birth_year": 0,
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "company": "string",
  • "contact_company": "string",
  • "contact_of": 0,
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "doublet_person_number": 0,
  • "extra_title": "string",
  • "extra_title_own": "string",
  • "first_name": "string",
  • "function": "string",
  • "function_own": "string",
  • "household": "string",
  • "id": 0,
  • "industry": "string",
  • "industry_code": "string",
  • "is_standard_contact": true,
  • "language_code": "string",
  • "last_name": "string",
  • "name_and_address": "string",
  • "note": "string",
  • "organisational_unit_code": "string",
  • "person_type": "PRIVATE",
  • "profession": "string",
  • "profession_code": "string",
  • "protection": "string",
  • "salutation_code": "string",
  • "sex_code": "SEXCODE_MALE",
  • "source": "string",
  • "title_code": "string",
  • "version": 1756369000008
}

Delete a person by ID

Removes a person record from the system based on their unique ID. Returns a success status (204 No Content) if the person is successfully deleted, or an error if the person is not found or cannot be deleted due to other reasons.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person to be deleted

Responses

Response samples

Content type
application/json
{ }

Update an existing person's details

Modifies the details of a specific person identified by their ID in the URL path. The updated person details are provided in the request body. Returns the updated person object and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person to be updated

Request Body schema: application/json
required

Updated person details

birth_day
integer <int32>
birth_month
integer <int32>
birth_year
integer <int32>
company
string
contact_of
integer <int32>
first_name
string
is_standard_contact
boolean
language_code
string
last_name
string
note
string
organisational_unit_code
string
person_type
string
Enum: "PRIVATE" "CONTACT" "ORGANIZATION"
qc_correct_first_name
boolean
qc_correct_person
boolean
qc_create_attribute
integer <int32>
qc_create_household
boolean
salutation_code
string
sex_code
string
Enum: "SEXCODE_MALE" "SEXCODE_FEMALE" "SEXCODE_EMPTY"
title_code
string
version
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "birth_day": 0,
  • "birth_month": 0,
  • "birth_year": 0,
  • "company": "string",
  • "contact_of": 0,
  • "first_name": "string",
  • "is_standard_contact": true,
  • "language_code": "string",
  • "last_name": "string",
  • "note": "string",
  • "organisational_unit_code": "string",
  • "person_type": "PRIVATE",
  • "qc_correct_first_name": true,
  • "qc_correct_person": true,
  • "qc_create_attribute": 0,
  • "qc_create_household": true,
  • "salutation_code": "string",
  • "sex_code": "SEXCODE_MALE",
  • "title_code": "string",
  • "version": 1756369000008
}

Response samples

Content type
application/json
{
  • "birth_day": 0,
  • "birth_month": 0,
  • "birth_year": 0,
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "company": "string",
  • "contact_company": "string",
  • "contact_of": 0,
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "doublet_person_number": 0,
  • "extra_title": "string",
  • "extra_title_own": "string",
  • "first_name": "string",
  • "function": "string",
  • "function_own": "string",
  • "household": "string",
  • "id": 0,
  • "industry": "string",
  • "industry_code": "string",
  • "is_standard_contact": true,
  • "language_code": "string",
  • "last_name": "string",
  • "name_and_address": "string",
  • "note": "string",
  • "organisational_unit_code": "string",
  • "person_type": "PRIVATE",
  • "profession": "string",
  • "profession_code": "string",
  • "protection": "string",
  • "salutation_code": "string",
  • "sex_code": "SEXCODE_MALE",
  • "source": "string",
  • "title_code": "string",
  • "version": 1756369000008
}

Get Person's Addresses

Returns a list of addresses associated with the given person ID. Results can be filtered by an optional query string.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person

query Parameters
query
string
Default: "active"
Example: query=active

Optional search query for addresses (active,standard,alternative, default)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new address for a person

Adds a new address record to the specified person's profile. The person's ID is taken from the URL path, and address details are provided in the request body. Returns the created address and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person to whom the address will be added

Request Body schema: application/json
required

Address details to create

address_addition
string
address_entry
string
address_type
string
city
string
comment
string
country
string
is_po_box
boolean
is_standard_address
boolean
po_box
string
po_box_city
string
po_box_postal_code
string
po_box_postal_code_addition
integer <int32>
postal_code
string
postal_code_addition
integer <int32>
qc_contact_change
boolean
qc_household_change
boolean
qc_publication_email
boolean
qc_raisenow_email
boolean
qc_recorrect_domain
boolean
qc_recorrect_person
boolean
qc_recorrect_telecom_format
boolean
street
string
street_number
string
valid_from
string
valid_to
string
version
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "address_addition": "string",
  • "address_entry": "string",
  • "address_type": "string",
  • "city": "string",
  • "comment": "string",
  • "country": "string",
  • "is_po_box": true,
  • "is_standard_address": true,
  • "po_box": "string",
  • "po_box_city": "string",
  • "po_box_postal_code": "string",
  • "po_box_postal_code_addition": 0,
  • "postal_code": "string",
  • "postal_code_addition": 0,
  • "qc_contact_change": true,
  • "qc_household_change": true,
  • "qc_publication_email": true,
  • "qc_raisenow_email": true,
  • "qc_recorrect_domain": true,
  • "qc_recorrect_person": true,
  • "qc_recorrect_telecom_format": true,
  • "street": "string",
  • "street_number": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Response samples

Content type
application/json
{
  • "address_addition": "string",
  • "address_entry": "string",
  • "address_lines": "string",
  • "address_sequence_number": 0,
  • "address_type": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "channel": "string",
  • "city": "string",
  • "comment": "string",
  • "country": "string",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "is_po_box": true,
  • "lock": "string",
  • "person_number": 0,
  • "po_box": "string",
  • "po_box_city": "string",
  • "po_box_postal_code": "string",
  • "po_box_postal_code_addition": 0,
  • "postal_code": "string",
  • "postal_code_addition": 0,
  • "protection": "string",
  • "source_relation": "string",
  • "source_relation_address": 0,
  • "state": "STANDARD",
  • "street": "string",
  • "street_number": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Delete a person's address

Removes a specific address associated with a person. The person ID and address ID are taken from the URL path. Returns a success status or an error if the address cannot be deleted.

Authorizations:
api_key_headerapi_key_query
path Parameters
addressId
required
string
Example: ADDR001

Unique identifier of the address to be deleted

id
required
integer <int32>
Example: 101

Unique identifier of the person whose address is to be deleted

Responses

Response samples

Content type
application/json
{ }

Update an existing address for a person

Modifies the details of a specific address associated with a person. The person ID and address ID are taken from the URL path, and updated address details are provided in the request body. Returns the updated address and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
addressId
required
string
Example: ADDR001

Unique identifier of the address to be updated

id
required
integer <int32>
Example: 101

Unique identifier of the person whose address is to be updated

Request Body schema: application/json
required

Updated address details

address_addition
string
address_entry
string
address_type
string
city
string
comment
string
country
string
is_po_box
boolean
is_standard_address
boolean
po_box
string
po_box_city
string
po_box_postal_code
string
po_box_postal_code_addition
integer <int32>
postal_code
string
postal_code_addition
integer <int32>
qc_contact_change
boolean
qc_household_change
boolean
qc_publication_email
boolean
qc_raisenow_email
boolean
qc_recorrect_domain
boolean
qc_recorrect_person
boolean
qc_recorrect_telecom_format
boolean
street
string
street_number
string
valid_from
string
valid_to
string
version
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "address_addition": "string",
  • "address_entry": "string",
  • "address_type": "string",
  • "city": "string",
  • "comment": "string",
  • "country": "string",
  • "is_po_box": true,
  • "is_standard_address": true,
  • "po_box": "string",
  • "po_box_city": "string",
  • "po_box_postal_code": "string",
  • "po_box_postal_code_addition": 0,
  • "postal_code": "string",
  • "postal_code_addition": 0,
  • "qc_contact_change": true,
  • "qc_household_change": true,
  • "qc_publication_email": true,
  • "qc_raisenow_email": true,
  • "qc_recorrect_domain": true,
  • "qc_recorrect_person": true,
  • "qc_recorrect_telecom_format": true,
  • "street": "string",
  • "street_number": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Get Person's Attributes

Returns a list of specific attributes or characteristics of the person.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new attribute for a person

Adds a new attribute record to the specified person's profile. The person's ID is taken from the URL path, and attribute details are provided in the request body. Returns the created attribute and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person to whom the attribute will be added

Request Body schema: application/json
required

Attribute details to create

attribute
string
attribute_description
string
attribute_value
string
changed_by
string
changed_on
string <date-time>
created_by
string
created_on
string <date-time>
id
string
valid_from
string
valid_to
string
version
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "attribute_description": "string",
  • "attribute_value": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Response samples

Content type
application/json
{
  • "attribute": "string",
  • "attribute_description": "string",
  • "attribute_value": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Delete a person's attribute

Removes a specific attribute (Merkmal) associated with a person. The person ID and attribute ID are taken from the URL path. Returns a success state or an error if the attribute cannot be deleted.

Authorizations:
api_key_headerapi_key_query
path Parameters
attributeId
required
string
Example: COLOR_PREF

Unique identifier of the attribute to be deleted

id
required
integer <int32>
Example: 101

Unique identifier of the person whose attribute is to be deleted

Responses

Response samples

Content type
application/json
{ }

Update an existing attribute for a person

Modifies the details of a specific attribute associated with a person. The person ID and attribute ID are taken from the URL path, and updated attribute details are provided in the request body. Returns the updated attribute and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
attributeId
required
string
Example: COLOR_PREF

Unique identifier of the attribute to be updated

id
required
integer <int32>
Example: 101

Unique identifier of the person whose attribute is to be updated

Request Body schema: application/json
required

Updated attribute details

attribute
string
attribute_description
string
attribute_value
string
changed_by
string
changed_on
string <date-time>
created_by
string
created_on
string <date-time>
id
string
valid_from
string
valid_to
string
version
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "attribute": "string",
  • "attribute_description": "string",
  • "attribute_value": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Response samples

Content type
application/json
{
  • "attribute": "string",
  • "attribute_description": "string",
  • "attribute_value": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Get Person's Interactions

Returns a list of recorded interactions with the given person.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new interaction for a person

Adds a new interaction record (e.g., meeting, phone call) to the specified person's profile. The person's ID is taken from the URL path, and interaction details are provided in the request body. Returns the created interaction and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person to whom the interaction will be added

Request Body schema: application/json
required

Interaction details to create

channel
string
interaction
string
interaction_date
string <date-time>
interaction_position
string
interaction_state
string
qc_thank_you
boolean
value
number

Responses

Request samples

Content type
application/json
{
  • "channel": "string",
  • "interaction": "string",
  • "interaction_date": "2019-08-24T14:15:22Z",
  • "interaction_position": "string",
  • "interaction_state": "string",
  • "qc_thank_you": true,
  • "value": 0
}

Response samples

Content type
application/json
{
  • "channel": "string",
  • "interaction": "string",
  • "interaction_date": "2019-08-24T14:15:22Z",
  • "interaction_position": "string",
  • "interaction_state": "string",
  • "qc_thank_you": true,
  • "value": 0
}

Delete a specific interaction for a person

Removes an interaction record from a person's profile based on the person ID and interaction ID. Returns a success status or an error if the interaction cannot be deleted.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person whose interaction is to be deleted

interactionId
required
string
Example: INTER987

Unique identifier of the interaction to be deleted

Responses

Response samples

Content type
application/json
{ }

Record a refusal for a specific interaction

Creates a record indicating that a particular interaction for a person has been refused. The person's ID and interaction ID are taken from the URL path, and refusal details (e.g., reason) are provided in the request body. Returns the created refusal record and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person associated with the interaction

interactionId
required
string
Example: INTER987

Unique identifier of the interaction being refused

Request Body schema: application/json
required

Details of the interaction refusal (e.g., reason)

id
string
interaction_date
string <date-time>
interaction_state
string
qc_date_issue
boolean
qc_household
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "interaction_date": "2019-08-24T14:15:22Z",
  • "interaction_state": "string",
  • "qc_date_issue": true,
  • "qc_household": true
}

Record a response or feedback for a specific interaction

Creates a record indicating a response or feedback related to a particular interaction for a person. The person's ID and interaction ID are taken from the URL path, and response details (e.g., type, text) are provided in the request body. Returns the created response record and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person associated with the interaction

interactionId
required
string
Example: INTER987

Unique identifier of the interaction to which this response applies

Request Body schema: application/json
required

Details of the interaction response (e.g., response type, text)

interaction_date
string <date-time>
qc_date_issue
boolean
qc_thank_you
boolean

Responses

Request samples

Content type
application/json
{
  • "interaction_date": "2019-08-24T14:15:22Z",
  • "qc_date_issue": true,
  • "qc_thank_you": true
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "channel": "string",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "date": "yyyy-MM-dd",
  • "id": "string",
  • "interaction": "string",
  • "interaction_state": "string",
  • "person": "string",
  • "reference": "string",
  • "response_value": 0,
  • "revenue_type": "string",
  • "version": 1756369000008
}

Get Person's Pledges

Returns a list of financial or other commitments made by the person.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new financial pledge for a person

Adds a new pledge record (e.g., donation, investment) to the specified person's profile. The person's ID is taken from the URL path, and pledge details are provided in the request body. Returns the created pledge and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person to whom the pledge will be added

Request Body schema: application/json
required

Pledge details to create

acquisition_date
string
acquisition_interaction
string
acquisition_interaction_channel
string
acquisition_interaction_position
string
acquisition_source
string
amount_paid
number
ausdat
string <date-time>
bank_account
string
bank_name
string
changed_by
string
changed_on
string <date-time>
charge_from
string
created_by
string
created_on
string <date-time>
credit_card
string
credit_card_expiration_month
integer <int32>
credit_card_expiration_year
integer <int32>
credit_card_holder
string
credit_card_number
string
credit_card_reference_id
string
current_number_of_revocations
integer <int32>
current_revoked_amount
number
default_amount
number
default_payment_number
integer <int32>
dunning_level
integer <int32>
esr_payment_slip_channel
string
Enum: "ESR_CHANNEL_EMPTY" "ESR_CHANNEL_E_MAIL"
exit_channel
string
exit_date
string
exit_interaction
string
external_memberschip_number
integer <int32>
id
string
institution_id
string
invoiced_annual_amount
number
is_master_pledge
boolean
last_correspondence_day
string
last_invoice_date
string
last_payment_date
string
last_revocation_date
string
master_pledge_person_number
integer <int32>
on_date
string
paid_by_person
string
paid_payments_number
integer <int32>
paid_to_year
integer <int32>
payment_mode
string
payment_number_per_year
string
Enum: "NUMBER_0" "NUMBER_1" "NUMBER_2" "NUMBER_4" "NUMBER_6" "NUMBER_12"
pledge
string
pledge_description
string
pledge_person_number
integer <int32>
pledge_type
string
postal_account
string
qc_raisenow_card
boolean
qc_valid_from
string
region_code
string
region_group
string
revocation_code
string
termination_reason
string
termination_reason_code
string
valid_from
string
valid_to
string
validity_code
string
version
integer <int64>
year_amount
number

Responses

Request samples

Content type
application/json
{
  • "acquisition_date": "yyyy-MM-dd",
  • "acquisition_interaction": "string",
  • "acquisition_interaction_channel": "string",
  • "acquisition_interaction_position": "string",
  • "acquisition_source": "string",
  • "amount_paid": 0,
  • "ausdat": "2019-08-24T14:15:22Z",
  • "bank_account": "string",
  • "bank_name": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "charge_from": "yyyy-MM-dd",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "credit_card": "string",
  • "credit_card_expiration_month": 0,
  • "credit_card_expiration_year": 0,
  • "credit_card_holder": "string",
  • "credit_card_number": "string",
  • "credit_card_reference_id": "string",
  • "current_number_of_revocations": 0,
  • "current_revoked_amount": 0,
  • "default_amount": 0,
  • "default_payment_number": 0,
  • "dunning_level": 0,
  • "esr_payment_slip_channel": "ESR_CHANNEL_EMPTY",
  • "exit_channel": "string",
  • "exit_date": "yyyy-MM-dd",
  • "exit_interaction": "string",
  • "external_memberschip_number": 0,
  • "id": "string",
  • "institution_id": "string",
  • "invoiced_annual_amount": 0,
  • "is_master_pledge": true,
  • "last_correspondence_day": "yyyy-MM-dd",
  • "last_invoice_date": "yyyy-MM-dd",
  • "last_payment_date": "yyyy-MM-dd",
  • "last_revocation_date": "yyyy-MM-dd",
  • "master_pledge_person_number": 0,
  • "on_date": "yyyy-MM-dd",
  • "paid_by_person": "string",
  • "paid_payments_number": 0,
  • "paid_to_year": 0,
  • "payment_mode": "string",
  • "payment_number_per_year": "NUMBER_0",
  • "pledge": "string",
  • "pledge_description": "string",
  • "pledge_person_number": 0,
  • "pledge_type": "string",
  • "postal_account": "string",
  • "qc_raisenow_card": true,
  • "qc_valid_from": "yyyy-MM-dd",
  • "region_code": "string",
  • "region_group": "string",
  • "revocation_code": "string",
  • "termination_reason": "string",
  • "termination_reason_code": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "validity_code": "string",
  • "version": 1756369000008,
  • "year_amount": 0
}

Response samples

Content type
application/json
{
  • "acquisition_date": "yyyy-MM-dd",
  • "acquisition_interaction": "string",
  • "acquisition_interaction_channel": "string",
  • "acquisition_interaction_position": "string",
  • "acquisition_source": "string",
  • "amount_paid": 0,
  • "ausdat": "2019-08-24T14:15:22Z",
  • "bank_account": "string",
  • "bank_name": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "charge_from": "yyyy-MM-dd",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "credit_card": "string",
  • "credit_card_expiration_month": 0,
  • "credit_card_expiration_year": 0,
  • "credit_card_holder": "string",
  • "credit_card_number": "string",
  • "credit_card_reference_id": "string",
  • "current_number_of_revocations": 0,
  • "current_revoked_amount": 0,
  • "default_amount": 0,
  • "default_payment_number": 0,
  • "dunning_level": 0,
  • "esr_payment_slip_channel": "ESR_CHANNEL_EMPTY",
  • "exit_channel": "string",
  • "exit_date": "yyyy-MM-dd",
  • "exit_interaction": "string",
  • "external_memberschip_number": 0,
  • "id": "string",
  • "institution_id": "string",
  • "invoiced_annual_amount": 0,
  • "is_master_pledge": true,
  • "last_correspondence_day": "yyyy-MM-dd",
  • "last_invoice_date": "yyyy-MM-dd",
  • "last_payment_date": "yyyy-MM-dd",
  • "last_revocation_date": "yyyy-MM-dd",
  • "master_pledge_person_number": 0,
  • "on_date": "yyyy-MM-dd",
  • "paid_by_person": "string",
  • "paid_payments_number": 0,
  • "paid_to_year": 0,
  • "payment_mode": "string",
  • "payment_number_per_year": "NUMBER_0",
  • "pledge": "string",
  • "pledge_description": "string",
  • "pledge_person_number": 0,
  • "pledge_type": "string",
  • "postal_account": "string",
  • "qc_raisenow_card": true,
  • "qc_valid_from": "yyyy-MM-dd",
  • "region_code": "string",
  • "region_group": "string",
  • "revocation_code": "string",
  • "termination_reason": "string",
  • "termination_reason_code": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "validity_code": "string",
  • "version": 1756369000008,
  • "year_amount": 0
}

Delete a specific financial pledge for a person

Removes a pledge record from a person's profile based on the person ID and pledge ID. Returns a success status (204 No Content) if the pledge is successfully deleted, or an error if the pledge is not found or cannot be deleted.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person whose pledge is to be deleted

pledgeId
required
string
Example: PLG001

Unique identifier of the pledge to be deleted

Responses

Response samples

Content type
application/json
{ }

Update an existing pledge for a person

Modifies the details of a specific pledge (Pledge) associated with a person. The person ID and pledge ID are taken from the URL path, and updated pledge details are provided in the request body. Returns the updated pledge and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person whose pledge is to be updated

pledgeId
required
string
Example: PLG001

Unique identifier of the pledge to be updated

Request Body schema: application/json
required

Updated pledge details

acquisition_date
string
acquisition_interaction
string
acquisition_interaction_channel
string
acquisition_interaction_position
string
acquisition_source
string
amount_paid
number
ausdat
string <date-time>
bank_account
string
bank_name
string
changed_by
string
changed_on
string <date-time>
charge_from
string
created_by
string
created_on
string <date-time>
credit_card
string
credit_card_expiration_month
integer <int32>
credit_card_expiration_year
integer <int32>
credit_card_holder
string
credit_card_number
string
credit_card_reference_id
string
current_number_of_revocations
integer <int32>
current_revoked_amount
number
default_amount
number
default_payment_number
integer <int32>
dunning_level
integer <int32>
esr_payment_slip_channel
string
Enum: "ESR_CHANNEL_EMPTY" "ESR_CHANNEL_E_MAIL"
exit_channel
string
exit_date
string
exit_interaction
string
external_memberschip_number
integer <int32>
id
string
institution_id
string
invoiced_annual_amount
number
is_master_pledge
boolean
last_correspondence_day
string
last_invoice_date
string
last_payment_date
string
last_revocation_date
string
master_pledge_person_number
integer <int32>
on_date
string
paid_by_person
string
paid_payments_number
integer <int32>
paid_to_year
integer <int32>
payment_mode
string
payment_number_per_year
string
Enum: "NUMBER_0" "NUMBER_1" "NUMBER_2" "NUMBER_4" "NUMBER_6" "NUMBER_12"
pledge
string
pledge_description
string
pledge_person_number
integer <int32>
pledge_type
string
postal_account
string
qc_raisenow_card
boolean
qc_valid_from
string
region_code
string
region_group
string
revocation_code
string
termination_reason
string
termination_reason_code
string
valid_from
string
valid_to
string
validity_code
string
version
integer <int64>
year_amount
number

Responses

Request samples

Content type
application/json
{
  • "acquisition_date": "yyyy-MM-dd",
  • "acquisition_interaction": "string",
  • "acquisition_interaction_channel": "string",
  • "acquisition_interaction_position": "string",
  • "acquisition_source": "string",
  • "amount_paid": 0,
  • "ausdat": "2019-08-24T14:15:22Z",
  • "bank_account": "string",
  • "bank_name": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "charge_from": "yyyy-MM-dd",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "credit_card": "string",
  • "credit_card_expiration_month": 0,
  • "credit_card_expiration_year": 0,
  • "credit_card_holder": "string",
  • "credit_card_number": "string",
  • "credit_card_reference_id": "string",
  • "current_number_of_revocations": 0,
  • "current_revoked_amount": 0,
  • "default_amount": 0,
  • "default_payment_number": 0,
  • "dunning_level": 0,
  • "esr_payment_slip_channel": "ESR_CHANNEL_EMPTY",
  • "exit_channel": "string",
  • "exit_date": "yyyy-MM-dd",
  • "exit_interaction": "string",
  • "external_memberschip_number": 0,
  • "id": "string",
  • "institution_id": "string",
  • "invoiced_annual_amount": 0,
  • "is_master_pledge": true,
  • "last_correspondence_day": "yyyy-MM-dd",
  • "last_invoice_date": "yyyy-MM-dd",
  • "last_payment_date": "yyyy-MM-dd",
  • "last_revocation_date": "yyyy-MM-dd",
  • "master_pledge_person_number": 0,
  • "on_date": "yyyy-MM-dd",
  • "paid_by_person": "string",
  • "paid_payments_number": 0,
  • "paid_to_year": 0,
  • "payment_mode": "string",
  • "payment_number_per_year": "NUMBER_0",
  • "pledge": "string",
  • "pledge_description": "string",
  • "pledge_person_number": 0,
  • "pledge_type": "string",
  • "postal_account": "string",
  • "qc_raisenow_card": true,
  • "qc_valid_from": "yyyy-MM-dd",
  • "region_code": "string",
  • "region_group": "string",
  • "revocation_code": "string",
  • "termination_reason": "string",
  • "termination_reason_code": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "validity_code": "string",
  • "version": 1756369000008,
  • "year_amount": 0
}

Response samples

Content type
application/json
{
  • "acquisition_date": "yyyy-MM-dd",
  • "acquisition_interaction": "string",
  • "acquisition_interaction_channel": "string",
  • "acquisition_interaction_position": "string",
  • "acquisition_source": "string",
  • "amount_paid": 0,
  • "ausdat": "2019-08-24T14:15:22Z",
  • "bank_account": "string",
  • "bank_name": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "charge_from": "yyyy-MM-dd",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "credit_card": "string",
  • "credit_card_expiration_month": 0,
  • "credit_card_expiration_year": 0,
  • "credit_card_holder": "string",
  • "credit_card_number": "string",
  • "credit_card_reference_id": "string",
  • "current_number_of_revocations": 0,
  • "current_revoked_amount": 0,
  • "default_amount": 0,
  • "default_payment_number": 0,
  • "dunning_level": 0,
  • "esr_payment_slip_channel": "ESR_CHANNEL_EMPTY",
  • "exit_channel": "string",
  • "exit_date": "yyyy-MM-dd",
  • "exit_interaction": "string",
  • "external_memberschip_number": 0,
  • "id": "string",
  • "institution_id": "string",
  • "invoiced_annual_amount": 0,
  • "is_master_pledge": true,
  • "last_correspondence_day": "yyyy-MM-dd",
  • "last_invoice_date": "yyyy-MM-dd",
  • "last_payment_date": "yyyy-MM-dd",
  • "last_revocation_date": "yyyy-MM-dd",
  • "master_pledge_person_number": 0,
  • "on_date": "yyyy-MM-dd",
  • "paid_by_person": "string",
  • "paid_payments_number": 0,
  • "paid_to_year": 0,
  • "payment_mode": "string",
  • "payment_number_per_year": "NUMBER_0",
  • "pledge": "string",
  • "pledge_description": "string",
  • "pledge_person_number": 0,
  • "pledge_type": "string",
  • "postal_account": "string",
  • "qc_raisenow_card": true,
  • "qc_valid_from": "yyyy-MM-dd",
  • "region_code": "string",
  • "region_group": "string",
  • "revocation_code": "string",
  • "termination_reason": "string",
  • "termination_reason_code": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "validity_code": "string",
  • "version": 1756369000008,
  • "year_amount": 0
}

Change the status of a specific pledge to 'exited' or similar

Updates the status of an existing pledge to indicate its exit or cancellation. The person ID and pledge ID are provided in the URL path. Returns the updated pledge details and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person whose pledge status will be updated

pledgeId
required
string
Example: PLG001

Unique identifier of the pledge whose status will be updated

Request Body schema: application/json
required

Delete pledge details

action
string
Enum: "ACTION_S" "ACTION_L"
channel
string
date
string <date-time>
id
string
interaction
string
interaction_position
string
interaction_type
string
person_number
integer <int32>
pledge
string
ui_RaiseNow_card
boolean
ui_booking_exists
boolean
ui_reactivate
boolean
ui_term_group
boolean

Responses

Request samples

Content type
application/json
{
  • "action": "ACTION_S",
  • "channel": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "interaction": "string",
  • "interaction_position": "string",
  • "interaction_type": "string",
  • "person_number": 0,
  • "pledge": "string",
  • "ui_RaiseNow_card": true,
  • "ui_booking_exists": true,
  • "ui_reactivate": true,
  • "ui_term_group": true
}

Response samples

Content type
application/json
{
  • "action": "ACTION_S",
  • "channel": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "interaction": "string",
  • "interaction_position": "string",
  • "interaction_type": "string",
  • "person_number": 0,
  • "pledge": "string",
  • "ui_RaiseNow_card": true,
  • "ui_booking_exists": true,
  • "ui_reactivate": true,
  • "ui_term_group": true
}

Get Person's Publications

Returns a list of publications associated with the given person ID.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update an existing publication for a person

Modifies the details of a specific publication associated with a person. The person ID and publication ID are taken from the URL path, and updated publication details are provided in the request body. Returns the updated publication and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person whose publication is to be updated

publicationId
required
string
Example: PUB001

Unique identifier of the publication to be updated

Request Body schema: application/json
required

Updated publication details

address_sequence_number
integer <int64>
channel
string
email_sequence_number_1
integer <int64>
email_sequence_number_2
integer <int64>
email_sequence_number_3
integer <int64>
quantity
integer <int32>
valid_from
string <date-time>
valid_to
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "address_sequence_number": 0,
  • "channel": "string",
  • "email_sequence_number_1": 0,
  • "email_sequence_number_2": 0,
  • "email_sequence_number_3": 0,
  • "quantity": 0,
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "address_sequence_number": 0,
  • "channel": "string",
  • "email_sequence_number_1": 0,
  • "email_sequence_number_2": 0,
  • "email_sequence_number_3": 0,
  • "quantity": 0,
  • "valid_from": "2019-08-24T14:15:22Z",
  • "valid_to": "2019-08-24T14:15:22Z"
}

Create a new task for a person

Adds a new task record (e.g., meeting, phone call) to the specified person's profile. The person's ID is taken from the URL path, and task details are provided in the request body. Returns the created task and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person to whom the interaction will be added

Request Body schema: application/json
required

Task details to create

date
string <date-time>
description
string
emai_list
string
interval
integer <int32>
note
string
owner
string
priority
string
Enum: "PRIORITY_H" "PRIORITY_N" "PRIORITY_T"
state
string
Enum: "STATE_B" "STATE_O" "STATE_W" "STATE_I" "STATE_Z"
task_typ
string
time_unit
string
Enum: "UNIT_O" "UNIT_D" "UNIT_W" "UNIT_M" "UNIT_Y"
to_date
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "emai_list": "string",
  • "interval": 0,
  • "note": "string",
  • "owner": "string",
  • "priority": "PRIORITY_H",
  • "state": "STATE_B",
  • "task_typ": "string",
  • "time_unit": "UNIT_O",
  • "to_date": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "date": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "emai_list": "string",
  • "interval": 0,
  • "note": "string",
  • "owner": "string",
  • "priority": "PRIORITY_H",
  • "state": "STATE_B",
  • "task_typ": "string",
  • "time_unit": "UNIT_O",
  • "to_date": "2019-08-24T14:15:22Z"
}

Update an existing task for a person

Modifies the details of a specific task associated with a person. The person ID and task ID are taken from the URL path, and updated task details are provided in the request body. Returns the updated task and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person whose attribute is to be updated

taskId
required
string
Example: COLOR_PREF

Unique identifier of the task to be updated

Request Body schema: application/json
required

Updated attribute details

changed_by
string
changed_on
string <date-time>
created_by
string
created_on
string <date-time>
date
string <date-time>
emailList
string
id
string
info
string
interval
integer <int32>
note
string
organisational_unit_code
string
owner
string
ownerCode
string
parent
string
person
string
person_name
string
priority
string
Enum: "PRIORITY_H" "PRIORITY_N" "PRIORITY_T"
processed
boolean
relation
string
repeatedly
boolean
state
string
Enum: "STATE_B" "STATE_O" "STATE_W" "STATE_I" "STATE_Z"
task_id
integer <int32>
task_number
integer <int32>
task_typ
string
task_typ_description
string
text
string
unit
string
Enum: "UNIT_" "UNIT_D" "UNIT_W" "UNIT_M" "UNIT_Y"
version
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "date": "2019-08-24T14:15:22Z",
  • "emailList": "string",
  • "id": "string",
  • "info": "string",
  • "interval": 0,
  • "note": "string",
  • "organisational_unit_code": "string",
  • "owner": "string",
  • "ownerCode": "string",
  • "parent": "string",
  • "person": "string",
  • "person_name": "string",
  • "priority": "PRIORITY_H",
  • "processed": true,
  • "relation": "string",
  • "repeatedly": true,
  • "state": "STATE_B",
  • "task_id": 0,
  • "task_number": 0,
  • "task_typ": "string",
  • "task_typ_description": "string",
  • "text": "string",
  • "unit": "UNIT_",
  • "version": 1756369000008
}

Response samples

Content type
application/json
{
  • "attribute": "string",
  • "attribute_description": "string",
  • "attribute_value": "string",
  • "changed_by": "string",
  • "changed_on": "2019-08-24T14:15:22Z",
  • "created_by": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "valid_from": "yyyy-MM-dd",
  • "valid_to": "yyyy-MM-dd",
  • "version": 1756369000008
}

Get Person's Tasks

Returns a list of tasks associated with the given person ID.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
integer <int32>
Example: 101

Unique identifier of the person

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search cities and postal codes

Retrieves a list of cities and their postal codes based on partial postal code or city name. At least one search parameter (postalcode or city) must be provided.

Authorizations:
api_key_headerapi_key_query
query Parameters
city
string
Example: city=Zurich

Partial or full city name to search for. Example: Zurich

postalcode
integer <int32>
Default: 0
Example: postalcode=8001

Partial or full postal code to search for. Example: 80

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all profession codes

Returns a list of all possible profession codes

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all salutation codes

Returns a list of all possible salutation codes

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all gender codes

Returns a list of all possible gender codes

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all task priorities

Returns a list of all possible values for task priority

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all task time units

Returns a list of all possible values for task time units

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all task settings

Returns a list of all possible task settings

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all task types

Returns a list of all possible task types

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all person titles

Returns a list of all possible person titles

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all Funtrade users

Returns a list of all active Funtrade users

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

funtrade Events API

EVENT API for Funtrade Event manipulation V1

Retrieve all cancellation reasons for participation

Returns a list of all possible cancellation reasons for participation

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new event

Create a new event. Event details are provided in the request body. Returns a new created event with success status or error indicator.

Authorizations:
api_key_headerapi_key_query
Request Body schema: application/json
required

Event details

date_end
string
date_start
string
description
string
document_code
string
document_set
string
event
string
event_fees_id
string
event_fees_position_id
string
event_type_name
string
notes
string
price
number
seats_max
integer <int32>
seats_min
integer <int32>
version
integer <int64>
year
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "date_end": "yyyy-MM-dd",
  • "date_start": "yyyy-MM-dd",
  • "description": "string",
  • "document_code": "string",
  • "document_set": "string",
  • "event": "string",
  • "event_fees_id": "string",
  • "event_fees_position_id": "string",
  • "event_type_name": "string",
  • "notes": "string",
  • "price": 0,
  • "seats_max": 0,
  • "seats_min": 0,
  • "version": 1756369000008,
  • "year": 0
}

Response samples

Content type
application/json
{
  • "cost": 0,
  • "date_end": "yyyy-MM-dd",
  • "date_start": "yyyy-MM-dd",
  • "description": "string",
  • "event": "string",
  • "event_fees_id": "string",
  • "event_fees_position_id": "string",
  • "event_type": "string",
  • "id": "string",
  • "location": "string",
  • "notes": "string",
  • "number_of_participants": 0,
  • "price": 0,
  • "registrations_confirmed": 0,
  • "registrations_provisional": 0,
  • "registrations_queued": 0,
  • "seats_max": 0,
  • "seats_min": 0,
  • "state": "IN_PROCESSING",
  • "year": 0
}

Retrieve all roles for event

Returns a list of all existing roles for event

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all event types

Returns a list of all existing event types

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve event detail by ID

Returns an event detail

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x86587658

Unique identifier of the event

Responses

Response samples

Content type
application/json
{
  • "cost": 0,
  • "date_end": "yyyy-MM-dd",
  • "date_start": "yyyy-MM-dd",
  • "description": "string",
  • "event": "string",
  • "event_fees_id": "string",
  • "event_fees_position_id": "string",
  • "event_type": "string",
  • "id": "string",
  • "location": "string",
  • "notes": "string",
  • "number_of_participants": 0,
  • "price": 0,
  • "registrations_confirmed": 0,
  • "registrations_provisional": 0,
  • "registrations_queued": 0,
  • "seats_max": 0,
  • "seats_min": 0,
  • "state": "IN_PROCESSING",
  • "year": 0
}

Delete an event

Delete a specific event. The event ID is taken from the URL pathReturns a success status or an error if the event cannot be deleted.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x89769867

Unique identifier of the Event whose Participant is to be deleted

Responses

Response samples

Content type
application/json
{ }

Update an event

Modifies the details of a specific event. The event ID is taken from the URL path, and updated event details are provided in the request body. Returns the updated Event and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x89769867

Unique identifier of the Event to be updated

Request Body schema: application/json
required

Updated event details

date_end
string
date_start
string
description
string
document_code
string
document_set
string
event
string
event_fees_id
string
event_fees_position_id
string
event_type_name
string
notes
string
price
number
seats_max
integer <int32>
seats_min
integer <int32>
version
integer <int64>
year
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "date_end": "yyyy-MM-dd",
  • "date_start": "yyyy-MM-dd",
  • "description": "string",
  • "document_code": "string",
  • "document_set": "string",
  • "event": "string",
  • "event_fees_id": "string",
  • "event_fees_position_id": "string",
  • "event_type_name": "string",
  • "notes": "string",
  • "price": 0,
  • "seats_max": 0,
  • "seats_min": 0,
  • "version": 1756369000008,
  • "year": 0
}

Response samples

Content type
application/json
{
  • "cost": 0,
  • "date_end": "yyyy-MM-dd",
  • "date_start": "yyyy-MM-dd",
  • "description": "string",
  • "event": "string",
  • "event_fees_id": "string",
  • "event_fees_position_id": "string",
  • "event_type": "string",
  • "id": "string",
  • "location": "string",
  • "notes": "string",
  • "number_of_participants": 0,
  • "price": 0,
  • "registrations_confirmed": 0,
  • "registrations_provisional": 0,
  • "registrations_queued": 0,
  • "seats_max": 0,
  • "seats_min": 0,
  • "state": "IN_PROCESSING",
  • "year": 0
}

Retrieve event participants for event by ID

Returns a list of all participants for event by ID

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x86587658

Unique identifier of the event

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Register new participant for an event by id

Adds a new attribute record to the specified person's profile. The event's ID is taken from the URL path, and participant details are provided in the request body. Returns the newly registered participant and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x9786101

Unique identifier of the event for which the participant will be registered

Request Body schema: application/json
required

Participant details to register

comment
string
event
string
invoice_to_id
integer <int32>
main_person_id
integer <int32>
participant_id
integer <int32>
price
number
qc_ag_post
boolean
qc_crtmaxanz
boolean
qc_la_post
boolean
qc_maxanz
boolean
qc_minanz
boolean
registration_date
string
registration_state
string
version
integer <int64>
waiting_queue_number
integer <int32>
year
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "event": "string",
  • "invoice_to_id": 0,
  • "main_person_id": 0,
  • "participant_id": 0,
  • "price": 0,
  • "qc_ag_post": true,
  • "qc_crtmaxanz": true,
  • "qc_la_post": true,
  • "qc_maxanz": true,
  • "qc_minanz": true,
  • "registration_date": "yyyy-MM-dd",
  • "registration_state": "string",
  • "version": 1756369000008,
  • "waiting_queue_number": 0,
  • "year": 0
}

Response samples

Content type
application/json
{
  • "age": 0,
  • "cancellation_reason": "string",
  • "comment": "string",
  • "date_expiration": "yyyy-MM-dd",
  • "date_payment": "yyyy-MM-dd",
  • "event": "string",
  • "gender": "string",
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_to_id": 0,
  • "main_person_id": 0,
  • "name_and_address": "string",
  • "note": "string",
  • "notified": "yyyy-MM-dd",
  • "participant_id": 0,
  • "payed": true,
  • "price": 0,
  • "promiser": true,
  • "queued": true,
  • "registration_date": "yyyy-MM-dd",
  • "registration_state": "string",
  • "role": "string",
  • "version": 1756369000008,
  • "waiting_queue_number": 0,
  • "year": 0
}

Retrieve all states for participants for specific event

Returns a list of all existing states for participant for specific event

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x86587658

Unique identifier of the event

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete an existing participant for an event

Delete a specific participant associated with an event. The event ID and participant ID are taken from the URL pathReturns a success status or an error if the participant cannot be deleted.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x89769867

Unique identifier of the Event whose Participant is to be deleted

participantId
required
string
Example: COLOR_PREF

Unique identifier of the Participant to be deleted

Responses

Response samples

Content type
application/json
{ }

Update an existing participant for an event

Modifies the details of a specific participant associated with an event. The event ID and participant ID are taken from the URL path, and updated participant details are provided in the request body. Returns the updated Participant and a success/error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x89769867

Unique identifier of the Event whose Participant is to be updated

participantId
required
string
Example: COLOR_PREF

Unique identifier of the Participant to be updated

Request Body schema: application/json
required

Updated attribute details

comment
string
event
string
invoice_to_id
integer <int32>
main_person_id
integer <int32>
participant_id
integer <int32>
price
number
qc_ag_post
boolean
qc_crtmaxanz
boolean
qc_la_post
boolean
qc_maxanz
boolean
qc_minanz
boolean
registration_date
string
registration_state
string
version
integer <int64>
waiting_queue_number
integer <int32>
year
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "event": "string",
  • "invoice_to_id": 0,
  • "main_person_id": 0,
  • "participant_id": 0,
  • "price": 0,
  • "qc_ag_post": true,
  • "qc_crtmaxanz": true,
  • "qc_la_post": true,
  • "qc_maxanz": true,
  • "qc_minanz": true,
  • "registration_date": "yyyy-MM-dd",
  • "registration_state": "string",
  • "version": 1756369000008,
  • "waiting_queue_number": 0,
  • "year": 0
}

Response samples

Content type
application/json
{
  • "age": 0,
  • "cancellation_reason": "string",
  • "comment": "string",
  • "date_expiration": "yyyy-MM-dd",
  • "date_payment": "yyyy-MM-dd",
  • "event": "string",
  • "gender": "string",
  • "id": "string",
  • "invoice_number": 0,
  • "invoice_to_id": 0,
  • "main_person_id": 0,
  • "name_and_address": "string",
  • "note": "string",
  • "notified": "yyyy-MM-dd",
  • "participant_id": 0,
  • "payed": true,
  • "price": 0,
  • "promiser": true,
  • "queued": true,
  • "registration_date": "yyyy-MM-dd",
  • "registration_state": "string",
  • "role": "string",
  • "version": 1756369000008,
  • "waiting_queue_number": 0,
  • "year": 0
}

Cancel an existing participant for an event

Cancel a specific participant associated with an event. The event ID and participant ID are taken from the URL path, and cancellation details are provided in the request body. Returns a success status or error indicator.

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x89769867

Unique identifier of the Event whose Participant is to be canceled

participantId
required
string
Example: COLOR_PREF

Unique identifier of the Participant to be canceled

Request Body schema: application/json
required

Cancellation details

cancellation_reason
string
remaining_amount
number
status_after_cancellation
string

Responses

Request samples

Content type
application/json
{
  • "cancellation_reason": "string",
  • "remaining_amount": 0,
  • "status_after_cancellation": "string"
}

Response samples

Content type
application/json
{ }

Retrieve all roles for specific participant

Returns a list of all roles for specific participant

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x89769867

Unique identifier of the Event

participantId
required
string
Example: COLOR_PREF

Unique identifier of the Participant

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all roles for specific event

Returns a list of all existing roles for specific event

Authorizations:
api_key_headerapi_key_query
path Parameters
id
required
string
Example: 0x86587658

Unique identifier of the event

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all events

Returns a list of all existing events

Authorizations:
api_key_headerapi_key_query
query Parameters
description
string

Description

details
boolean
Example: details=true

Details

end_date
string <date-time>
Example: end_date=2025-12-05

End date (in ISO-Form)

event
string

Event

start_date_from
string <date-time>
Example: start_date_from=2025-11-02

Start date from (in ISO-Form). Default: today's date if no parameters are provided.

start_date_to
string <date-time>
Example: start_date_to=2025-11-02

Start date to (in ISO-Form)

year
integer <int32>
Default: 0
Example: year=2025

Year of the event

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all roles for participants

Returns a list of all existing roles for participant

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all states for participants

Returns a list of all existing states for participant

Authorizations:
api_key_headerapi_key_query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve all participations for person by ID

Returns a list of all participations for person by ID

Authorizations:
api_key_headerapi_key_query
path Parameters
personId
required
integer <int32>
Example: 123

Unique identifier of the Person

Responses

Response samples

Content type
application/json
[
  • {
    }
]