Skip to content
/
List 'Subtenant'

Accounts (2.0.0)

The 'Accounts' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Subtenantcontractconnection

Operations

Subtenanttenantconnection

Operations

Tenant

Operations

Organizationuser

Operations

Subtenant

Operations

Bulk write 'Subtenant'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/jsonArray [
allow_errands_access_through_connectionsbooleanrequired
allow_personal_information_accessbooleanrequired
add_connection_description_on_invoicebooleanrequired
allow_notificationsbooleanrequired
allow_revenue_row_accessbooleanrequired
allow_brf_accessbooleanrequired
allow_cancel_contract_accessbooleanrequired
allow_errands_accessbooleanrequired
allow_contracts_accessbooleanrequired
allow_invoice_accessbooleanrequired
allow_objects_accessbooleanrequired
allow_my_pages_accessbooleanrequired
org_nostring or null(luhn)[ 10 .. 11 ] characters
block_sms_notifications_forArray of objects
previous_addressobject or null(Address)
organizationobject or null(Organization)
block_notifications_forArray of objects
current_registered_addressobject or null(Address)
invoice_emailstring or null(email)<= 254 characters
sni_numberstring or null<= 6 characters

Additional Validation Information:

This value requires that the following fields are also set: corporate_name

Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
ssn_is_coordination_numberboolean
profile_pictureobject or null
is_activeboolean
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
allows_external_personal_information_sharingboolean or null
autogiro_disables_invoice_distributionboolean
fmistring or null[ 17 .. 20 ] characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
future_addressobject or null(Address)
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
custom_idstring or null<= 128 characters
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
popular_namestring or null<= 255 characters
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

block_email_notifications_forArray of objects
anonymizedboolean
wants_evictedboolean
realestatesArray of objects(Realestate)
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_addressobject or null(Address)
anonymization_namestring or null<= 255 characters
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

]
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/subtenant/list/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '[
    {
      "org_no": "stringstri",
      "block_sms_notifications_for": [
        null
      ],
      "previous_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "block_notifications_for": [
        null
      ],
      "allow_errands_access_through_connections": true,
      "current_registered_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "invoice_email": "user@example.com",
      "sni_number": "20.520",
      "allow_personal_information_access": true,
      "ssn_is_coordination_number": true,
      "profile_picture": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "is_active": true,
      "add_connection_description_on_invoice": true,
      "gln13_number": "stringstrings",
      "allows_external_personal_information_sharing": true,
      "autogiro_disables_invoice_distribution": true,
      "fmi": "stringstringstrin",
      "allow_notifications": true,
      "allow_revenue_row_access": true,
      "allow_brf_access": true,
      "phone_number": "string",
      "peppol_id": "stringstringstr",
      "future_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "allow_cancel_contract_access": true,
      "allow_errands_access": true,
      "birth_date": "2019-08-24",
      "email": "user@example.com",
      "custom_id": "string",
      "send_out_distribution_instruction": [
        null
      ],
      "active_to": "2019-08-24T14:15:22Z",
      "popular_name": "string",
      "last_name": "string",
      "first_name": "string",
      "allow_contracts_access": true,
      "block_email_notifications_for": [
        null
      ],
      "anonymized": true,
      "wants_evicted": true,
      "allow_invoice_access": true,
      "realestates": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "ssn": "stringstring",
      "invoice_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "allow_objects_access": true,
      "anonymization_name": "string",
      "allow_my_pages_access": true,
      "corporate_name": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
allow_errands_access_through_connectionsbooleanrequired
allow_personal_information_accessbooleanrequired
add_connection_description_on_invoicebooleanrequired
allow_notificationsbooleanrequired
allow_revenue_row_accessbooleanrequired
allow_brf_accessbooleanrequired
allow_cancel_contract_accessbooleanrequired
allow_errands_accessbooleanrequired
allow_contracts_accessbooleanrequired
allow_invoice_accessbooleanrequired
allow_objects_accessbooleanrequired
allow_my_pages_accessbooleanrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

mfa_has_hotpboolean or nullread-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
block_sms_notifications_forArray of objects
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

is_companyanyread-only
previous_addressobject or null(Address)
organizationobject or null(Organization)
block_notifications_forArray of objects
current_registered_addressobject or null(Address)
invoice_emailstring or null(email)<= 254 characters
sni_numberstring or null<= 6 characters

Additional Validation Information:

This value requires that the following fields are also set: corporate_name

Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
ssn_is_coordination_numberboolean
profile_pictureobject or null
is_activeboolean
hotp_invite_sendout_timestring or null(date-time)read-only
mfa_has_totpboolean or nullread-only
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
allows_external_personal_information_sharingboolean or null
last_loginstring or null(date-time)read-only
customer_columnsanyread-only
autogiro_disables_invoice_distributionboolean
fmistring or null[ 17 .. 20 ] characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
pending_monitor_approval_amountanyread-only
future_addressobject or null(Address)
created_atstring(date-time)read-only
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
custom_idstring or null<= 128 characters
full_nameanyread-only
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
tagsanyread-only
popular_namestring or null<= 255 characters
email_verifiedbooleanread-only
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

latest_active_datestring or null(date)read-only
block_email_notifications_forArray of objects
anonymizedboolean
earliest_active_datestring or null(date)read-only
wants_evictedboolean
communication_nameanyread-only
realestatesArray of objects(Realestate)
custom_application_domainstring or null<= 255 charactersread-only
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_addressobject or null(Address)
anonymization_namestring or null<= 255 characters
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

phone_number_verifiedbooleanread-only
]
Response
application/json
[
  {
    "mfa_has_hotp": true,
    "org_no": "stringstri",
    "block_sms_notifications_for": [ … ],
    "username": "stringst",
    "is_company": null,
    "previous_address": { … },
    "organization": { … },
    "block_notifications_for": [ … ],
    "allow_errands_access_through_connections": true,
    "current_registered_address": { … },
    "invoice_email": "user@example.com",
    "sni_number": "20.520",
    "allow_personal_information_access": true,
    "ssn_is_coordination_number": true,
    "profile_picture": { … },
    "is_active": true,
    "add_connection_description_on_invoice": true,
    "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
    "mfa_has_totp": true,
    "gln13_number": "stringstrings",
    "allows_external_personal_information_sharing": true,
    "last_login": "2019-08-24T14:15:22Z",
    "customer_columns": null,
    "autogiro_disables_invoice_distribution": true,
    "fmi": "stringstringstrin",
    "allow_notifications": true,
    "allow_revenue_row_access": true,
    "allow_brf_access": true,
    "phone_number": "string",
    "peppol_id": "stringstringstr",
    "pending_monitor_approval_amount": null,
    "future_address": { … },
    "allow_cancel_contract_access": true,
    "created_at": "2019-08-24T14:15:22Z",
    "allow_errands_access": true,
    "birth_date": "2019-08-24",
    "email": "user@example.com",
    "custom_id": "string",
    "full_name": null,
    "send_out_distribution_instruction": [ … ],
    "active_to": "2019-08-24T14:15:22Z",
    "tags": null,
    "popular_name": "string",
    "email_verified": true,
    "last_name": "string",
    "first_name": "string",
    "allow_contracts_access": true,
    "latest_active_date": "2019-08-24",
    "block_email_notifications_for": [ … ],
    "anonymized": true,
    "earliest_active_date": "2019-08-24",
    "wants_evicted": true,
    "allow_invoice_access": true,
    "communication_name": null,
    "realestates": [ … ],
    "custom_application_domain": "string",
    "ssn": "stringstring",
    "invoice_address": { … },
    "allow_objects_access": true,
    "anonymization_name": "string",
    "allow_my_pages_access": true,
    "corporate_name": "string",
    "phone_number_verified": true,
    "status": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
]

List 'Subtenant'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

This value must be set together with the following fields: _page_size

_page_sizeinteger(int32)

Additional Validation Information:

This value must be set together with the following fields: _page

_searchstring
_slimboolean
_statisticsboolean
customer_columnsArray of objects
global_realestatesArray of objects
global_segmentsArray of objects
tagsArray of objects
active_toany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

add_connection_description_on_invoiceany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_brf_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_cancel_contract_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_contracts_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_errands_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_errands_access_through_connectionsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_invoice_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_my_pages_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_notificationsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_objects_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_personal_information_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_revenue_row_accessany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allows_external_personal_information_sharingany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

anonymization_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

anonymizedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

autogiro_disables_invoice_distributionany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

birth_dateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

corporate_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

current_registered_addressany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

custom_application_domainany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

earliest_active_dateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

emailany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

email_verifiedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

first_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

fmiany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

future_addressany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

gln13_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

hotp_invite_sendout_timeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

invoice_addressany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

invoice_emailany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

is_activeany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

last_loginany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

last_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

latest_active_dateany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

mfa_has_hotpany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

mfa_has_totpany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

org_noany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

peppol_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

phone_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

phone_number_verifiedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

popular_nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

prefer_invoice_view_onlyany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

previous_addressany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

realestatesany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

sni_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

ssnany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

ssn_is_coordination_numberany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

statusany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

usernameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

wants_evictedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/accounts/users/customer/subtenant/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful query

Bodyapplication/jsonArray [
allow_errands_access_through_connectionsbooleanrequired
allow_personal_information_accessbooleanrequired
add_connection_description_on_invoicebooleanrequired
allow_notificationsbooleanrequired
allow_revenue_row_accessbooleanrequired
allow_brf_accessbooleanrequired
allow_cancel_contract_accessbooleanrequired
allow_errands_accessbooleanrequired
allow_contracts_accessbooleanrequired
allow_invoice_accessbooleanrequired
allow_objects_accessbooleanrequired
allow_my_pages_accessbooleanrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

mfa_has_hotpboolean or nullread-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
block_sms_notifications_forArray of objects
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

is_companyanyread-only
previous_addressobject or null(Address)
organizationobject or null(Organization)
block_notifications_forArray of objects
current_registered_addressobject or null(Address)
invoice_emailstring or null(email)<= 254 characters
sni_numberstring or null<= 6 characters

Additional Validation Information:

This value requires that the following fields are also set: corporate_name

Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
ssn_is_coordination_numberboolean
profile_pictureobject or null
is_activeboolean
hotp_invite_sendout_timestring or null(date-time)read-only
mfa_has_totpboolean or nullread-only
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
allows_external_personal_information_sharingboolean or null
last_loginstring or null(date-time)read-only
customer_columnsanyread-only
autogiro_disables_invoice_distributionboolean
fmistring or null[ 17 .. 20 ] characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
pending_monitor_approval_amountanyread-only
future_addressobject or null(Address)
created_atstring(date-time)read-only
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
custom_idstring or null<= 128 characters
full_nameanyread-only
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
tagsanyread-only
popular_namestring or null<= 255 characters
email_verifiedbooleanread-only
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

latest_active_datestring or null(date)read-only
block_email_notifications_forArray of objects
anonymizedboolean
earliest_active_datestring or null(date)read-only
wants_evictedboolean
communication_nameanyread-only
realestatesArray of objects(Realestate)
custom_application_domainstring or null<= 255 charactersread-only
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_addressobject or null(Address)
anonymization_namestring or null<= 255 characters
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

phone_number_verifiedbooleanread-only
]
Response
application/json
[
  {
    "mfa_has_hotp": true,
    "org_no": "stringstri",
    "block_sms_notifications_for": [ … ],
    "username": "stringst",
    "is_company": null,
    "previous_address": { … },
    "organization": { … },
    "block_notifications_for": [ … ],
    "allow_errands_access_through_connections": true,
    "current_registered_address": { … },
    "invoice_email": "user@example.com",
    "sni_number": "20.520",
    "allow_personal_information_access": true,
    "ssn_is_coordination_number": true,
    "profile_picture": { … },
    "is_active": true,
    "add_connection_description_on_invoice": true,
    "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
    "mfa_has_totp": true,
    "gln13_number": "stringstrings",
    "allows_external_personal_information_sharing": true,
    "last_login": "2019-08-24T14:15:22Z",
    "customer_columns": null,
    "autogiro_disables_invoice_distribution": true,
    "fmi": "stringstringstrin",
    "allow_notifications": true,
    "allow_revenue_row_access": true,
    "allow_brf_access": true,
    "phone_number": "string",
    "peppol_id": "stringstringstr",
    "pending_monitor_approval_amount": null,
    "future_address": { … },
    "allow_cancel_contract_access": true,
    "created_at": "2019-08-24T14:15:22Z",
    "allow_errands_access": true,
    "birth_date": "2019-08-24",
    "email": "user@example.com",
    "custom_id": "string",
    "full_name": null,
    "send_out_distribution_instruction": [ … ],
    "active_to": "2019-08-24T14:15:22Z",
    "tags": null,
    "popular_name": "string",
    "email_verified": true,
    "last_name": "string",
    "first_name": "string",
    "allow_contracts_access": true,
    "latest_active_date": "2019-08-24",
    "block_email_notifications_for": [ … ],
    "anonymized": true,
    "earliest_active_date": "2019-08-24",
    "wants_evicted": true,
    "allow_invoice_access": true,
    "communication_name": null,
    "realestates": [ … ],
    "custom_application_domain": "string",
    "ssn": "stringstring",
    "invoice_address": { … },
    "allow_objects_access": true,
    "anonymization_name": "string",
    "allow_my_pages_access": true,
    "corporate_name": "string",
    "phone_number_verified": true,
    "status": 0,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
]

Update 'Subtenant'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
Bodyapplication/json
allow_errands_access_through_connectionsbooleanrequired
allow_personal_information_accessbooleanrequired
add_connection_description_on_invoicebooleanrequired
allow_notificationsbooleanrequired
allow_revenue_row_accessbooleanrequired
allow_brf_accessbooleanrequired
allow_cancel_contract_accessbooleanrequired
allow_errands_accessbooleanrequired
allow_contracts_accessbooleanrequired
allow_invoice_accessbooleanrequired
allow_objects_accessbooleanrequired
allow_my_pages_accessbooleanrequired
org_nostring or null(luhn)[ 10 .. 11 ] characters
block_sms_notifications_forArray of objects
previous_addressobject or null(Address)
organizationobject or null(Organization)
block_notifications_forArray of objects
current_registered_addressobject or null(Address)
invoice_emailstring or null(email)<= 254 characters
sni_numberstring or null<= 6 characters

Additional Validation Information:

This value requires that the following fields are also set: corporate_name

Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
ssn_is_coordination_numberboolean
profile_pictureobject or null
is_activeboolean
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
allows_external_personal_information_sharingboolean or null
autogiro_disables_invoice_distributionboolean
fmistring or null[ 17 .. 20 ] characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
future_addressobject or null(Address)
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
custom_idstring or null<= 128 characters
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
popular_namestring or null<= 255 characters
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

block_email_notifications_forArray of objects
anonymizedboolean
wants_evictedboolean
realestatesArray of objects(Realestate)
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_addressobject or null(Address)
anonymization_namestring or null<= 255 characters
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

curl -i -X PATCH \
  'https://dev.api.pigello.io/accounts/users/customer/subtenant/{pk}/' \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "org_no": "stringstri",
    "block_sms_notifications_for": [
      null
    ],
    "previous_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "block_notifications_for": [
      null
    ],
    "allow_errands_access_through_connections": true,
    "current_registered_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "invoice_email": "user@example.com",
    "sni_number": "20.520",
    "allow_personal_information_access": true,
    "ssn_is_coordination_number": true,
    "profile_picture": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "is_active": true,
    "add_connection_description_on_invoice": true,
    "gln13_number": "stringstrings",
    "allows_external_personal_information_sharing": true,
    "autogiro_disables_invoice_distribution": true,
    "fmi": "stringstringstrin",
    "allow_notifications": true,
    "allow_revenue_row_access": true,
    "allow_brf_access": true,
    "phone_number": "string",
    "peppol_id": "stringstringstr",
    "future_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "allow_cancel_contract_access": true,
    "allow_errands_access": true,
    "birth_date": "2019-08-24",
    "email": "user@example.com",
    "custom_id": "string",
    "send_out_distribution_instruction": [
      null
    ],
    "active_to": "2019-08-24T14:15:22Z",
    "popular_name": "string",
    "last_name": "string",
    "first_name": "string",
    "allow_contracts_access": true,
    "block_email_notifications_for": [
      null
    ],
    "anonymized": true,
    "wants_evicted": true,
    "allow_invoice_access": true,
    "realestates": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "ssn": "stringstring",
    "invoice_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "allow_objects_access": true,
    "anonymization_name": "string",
    "allow_my_pages_access": true,
    "corporate_name": "string"
  }'

Responses

Successful update

Bodyapplication/json
allow_errands_access_through_connectionsbooleanrequired
allow_personal_information_accessbooleanrequired
add_connection_description_on_invoicebooleanrequired
allow_notificationsbooleanrequired
allow_revenue_row_accessbooleanrequired
allow_brf_accessbooleanrequired
allow_cancel_contract_accessbooleanrequired
allow_errands_accessbooleanrequired
allow_contracts_accessbooleanrequired
allow_invoice_accessbooleanrequired
allow_objects_accessbooleanrequired
allow_my_pages_accessbooleanrequired
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

mfa_has_hotpboolean or nullread-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
block_sms_notifications_forArray of objects
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

is_companyanyread-only
previous_addressobject or null(Address)
organizationobject or null(Organization)
block_notifications_forArray of objects
current_registered_addressobject or null(Address)
invoice_emailstring or null(email)<= 254 characters
sni_numberstring or null<= 6 characters

Additional Validation Information:

This value requires that the following fields are also set: corporate_name

Enum"20.520""78.300""68.310""79.900""96.090""32.910""46.630""20.59""20.160""42.110"
ssn_is_coordination_numberboolean
profile_pictureobject or null
is_activeboolean
hotp_invite_sendout_timestring or null(date-time)read-only
mfa_has_totpboolean or nullread-only
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
allows_external_personal_information_sharingboolean or null
last_loginstring or null(date-time)read-only
customer_columnsanyread-only
autogiro_disables_invoice_distributionboolean
fmistring or null[ 17 .. 20 ] characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
pending_monitor_approval_amountanyread-only
future_addressobject or null(Address)
created_atstring(date-time)read-only
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
custom_idstring or null<= 128 characters
full_nameanyread-only
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
tagsanyread-only
popular_namestring or null<= 255 characters
email_verifiedbooleanread-only
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

latest_active_datestring or null(date)read-only
block_email_notifications_forArray of objects
anonymizedboolean
earliest_active_datestring or null(date)read-only
wants_evictedboolean
communication_nameanyread-only
realestatesArray of objects(Realestate)
custom_application_domainstring or null<= 255 charactersread-only
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_addressobject or null(Address)
anonymization_namestring or null<= 255 characters
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

phone_number_verifiedbooleanread-only
Response
application/json
{
  "mfa_has_hotp": true,
  "org_no": "stringstri",
  "block_sms_notifications_for": [
    null
  ],
  "username": "stringst",
  "is_company": null,
  "previous_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "block_notifications_for": [
    null
  ],
  "allow_errands_access_through_connections": true,
  "current_registered_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "invoice_email": "user@example.com",
  "sni_number": "20.520",
  "allow_personal_information_access": true,
  "ssn_is_coordination_number": true,
  "profile_picture": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "is_active": true,
  "add_connection_description_on_invoice": true,
  "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
  "mfa_has_totp": true,
  "gln13_number": "stringstrings",
  "allows_external_personal_information_sharing": true,
  "last_login": "2019-08-24T14:15:22Z",
  "customer_columns": null,
  "autogiro_disables_invoice_distribution": true,
  "fmi": "stringstringstrin",
  "allow_notifications": true,
  "allow_revenue_row_access": true,
  "allow_brf_access": true,
  "phone_number": "string",
  "peppol_id": "stringstringstr",
  "pending_monitor_approval_amount": null,
  "future_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "allow_cancel_contract_access": true,
  "created_at": "2019-08-24T14:15:22Z",
  "allow_errands_access": true,
  "birth_date": "2019-08-24",
  "email": "user@example.com",
  "custom_id": "string",
  "full_name": null,
  "send_out_distribution_instruction": [
    null
  ],
  "active_to": "2019-08-24T14:15:22Z",
  "tags": null,
  "popular_name": "string",
  "email_verified": true,
  "last_name": "string",
  "first_name": "string",
  "allow_contracts_access": true,
  "latest_active_date": "2019-08-24",
  "block_email_notifications_for": [
    null
  ],
  "anonymized": true,
  "earliest_active_date": "2019-08-24",
  "wants_evicted": true,
  "allow_invoice_access": true,
  "communication_name": null,
  "realestates": [
    { … }
  ],
  "custom_application_domain": "string",
  "ssn": "stringstring",
  "invoice_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "allow_objects_access": true,
  "anonymization_name": "string",
  "allow_my_pages_access": true,
  "corporate_name": "string",
  "phone_number_verified": true,
  "status": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Organizationuserworkengagement

Operations

Organizationusersegment

Operations

Integrationuseragent

Operations

Protectedidentity

Operations

Workengagement

Operations
© Pigello. All rights reserved.