Skip to content
/
Create 'Tenant'

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

Create 'Tenant'

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/json
block_notifications_forArray of objects
autogiro_disables_invoice_distributionboolean
birth_datestring or null(date)
send_out_distribution_instructionArray of objects or null
ssn_is_coordination_numberboolean
anonymization_namestring or null<= 255 characters
reminder_distribution_instructionArray of objects or null
block_email_notifications_forArray of objects
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
ssnstring or null(luhn)[ 12 .. 13 ] characters
debt_distribution_instructionArray of objects or null
current_registered_addressobject or null(Address)
allows_external_personal_information_sharingboolean or null
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

popular_namestring or null<= 255 characters
future_addressobject or null(Address)
anonymizedboolean
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

custom_dimension_category_valuestring or null<= 255 characters
realestatesArray of objects(Realestate)
profile_pictureobject or null
active_tostring or null(date-time)
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

invoice_distribution_instructionArray of objects or null
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"
fmistring or null[ 17 .. 20 ] characters
org_nostring or null(luhn)[ 10 .. 11 ] characters
invoice_addressobject or null(Address)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
prefer_invoice_view_onlyboolean
organizationobject or null(Organization)
show_in_brf_contextboolean
block_sms_notifications_forArray of objects
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
is_activeboolean
previous_addressobject or null(Address)
wants_evictedboolean
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/tenant/ \
  -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 '{
    "block_notifications_for": [
      null
    ],
    "autogiro_disables_invoice_distribution": true,
    "birth_date": "2019-08-24",
    "send_out_distribution_instruction": [
      null
    ],
    "ssn_is_coordination_number": true,
    "anonymization_name": "string",
    "reminder_distribution_instruction": [
      null
    ],
    "block_email_notifications_for": [
      null
    ],
    "gln13_number": "stringstrings",
    "ssn": "stringstring",
    "debt_distribution_instruction": [
      null
    ],
    "current_registered_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "allows_external_personal_information_sharing": true,
    "corporate_name": "string",
    "popular_name": "string",
    "future_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "anonymized": true,
    "first_name": "string",
    "custom_dimension_category_value": "string",
    "realestates": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "profile_picture": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "active_to": "2019-08-24T14:15:22Z",
    "last_name": "string",
    "invoice_distribution_instruction": [
      null
    ],
    "invoice_email": "user@example.com",
    "sni_number": "20.520",
    "fmi": "stringstringstrin",
    "org_no": "stringstri",
    "invoice_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "custom_dimension_value": "string",
    "prefer_invoice_view_only": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "show_in_brf_context": true,
    "block_sms_notifications_for": [
      null
    ],
    "peppol_id": "stringstringstr",
    "is_active": true,
    "previous_address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "wants_evicted": true,
    "email": "user@example.com",
    "phone_number": "string"
  }'

Responses

Successful creation

Bodyapplication/json
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

block_notifications_forArray of objects
autogiro_disables_invoice_distributionboolean
birth_datestring or null(date)
send_out_distribution_instructionArray of objects or null
ssn_is_coordination_numberboolean
anonymization_namestring or null<= 255 characters
full_nameanyread-only
reminder_distribution_instructionArray of objects or null
block_email_notifications_forArray of objects
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
ssnstring or null(luhn)[ 12 .. 13 ] characters
tagsanyread-only
mfa_has_hotpboolean or nullread-only
debt_distribution_instructionArray of objects or null
current_registered_addressobject or null(Address)
customer_columnsanyread-only
allows_external_personal_information_sharingboolean or null
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

popular_namestring or null<= 255 characters
latest_active_datestring or null(date)read-only
future_addressobject or null(Address)
anonymizedboolean
email_verifiedbooleanread-only
custom_application_domainstring or null<= 255 charactersread-only
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

custom_dimension_category_valuestring or null<= 255 characters
created_atstring(date-time)read-only
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

realestatesArray of objects(Realestate)
last_loginstring or null(date-time)read-only
profile_pictureobject or null
active_tostring or null(date-time)
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

invoice_distribution_instructionArray of objects or null
pending_monitor_approval_amountanyread-only
invoice_emailstring or null(email)<= 254 characters
mfa_has_totpboolean or nullread-only
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"
fmistring or null[ 17 .. 20 ] characters
phone_number_verifiedbooleanread-only
hotp_invite_sendout_timestring or null(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
invoice_addressobject or null(Address)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
prefer_invoice_view_onlyboolean
organizationobject or null(Organization)
show_in_brf_contextboolean
is_companyanyread-only
block_sms_notifications_forArray of objects
earliest_active_datestring or null(date)read-only
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
is_activeboolean
previous_addressobject or null(Address)
wants_evictedboolean
communication_nameanyread-only
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
Response
application/json
{
  "block_notifications_for": [
    null
  ],
  "autogiro_disables_invoice_distribution": true,
  "birth_date": "2019-08-24",
  "send_out_distribution_instruction": [
    null
  ],
  "ssn_is_coordination_number": true,
  "anonymization_name": "string",
  "full_name": null,
  "reminder_distribution_instruction": [
    null
  ],
  "block_email_notifications_for": [
    null
  ],
  "gln13_number": "stringstrings",
  "ssn": "stringstring",
  "tags": null,
  "mfa_has_hotp": true,
  "debt_distribution_instruction": [
    null
  ],
  "current_registered_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "customer_columns": null,
  "allows_external_personal_information_sharing": true,
  "corporate_name": "string",
  "popular_name": "string",
  "latest_active_date": "2019-08-24",
  "future_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "anonymized": true,
  "email_verified": true,
  "custom_application_domain": "string",
  "first_name": "string",
  "custom_dimension_category_value": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "username": "stringst",
  "realestates": [
    { … }
  ],
  "last_login": "2019-08-24T14:15:22Z",
  "profile_picture": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "active_to": "2019-08-24T14:15:22Z",
  "last_name": "string",
  "invoice_distribution_instruction": [
    null
  ],
  "pending_monitor_approval_amount": null,
  "invoice_email": "user@example.com",
  "mfa_has_totp": true,
  "sni_number": "20.520",
  "fmi": "stringstringstrin",
  "phone_number_verified": true,
  "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
  "org_no": "stringstri",
  "invoice_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "custom_dimension_value": "string",
  "prefer_invoice_view_only": true,
  "status": 0,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "show_in_brf_context": true,
  "is_company": null,
  "block_sms_notifications_for": [
    null
  ],
  "earliest_active_date": "2019-08-24",
  "peppol_id": "stringstringstr",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "is_active": true,
  "previous_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "wants_evicted": true,
  "communication_name": null,
  "email": "user@example.com",
  "phone_number": "string"
}

Bulk write 'Tenant'

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 [
block_notifications_forArray of objects
autogiro_disables_invoice_distributionboolean
birth_datestring or null(date)
send_out_distribution_instructionArray of objects or null
ssn_is_coordination_numberboolean
anonymization_namestring or null<= 255 characters
reminder_distribution_instructionArray of objects or null
block_email_notifications_forArray of objects
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
ssnstring or null(luhn)[ 12 .. 13 ] characters
debt_distribution_instructionArray of objects or null
current_registered_addressobject or null(Address)
allows_external_personal_information_sharingboolean or null
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

popular_namestring or null<= 255 characters
future_addressobject or null(Address)
anonymizedboolean
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

custom_dimension_category_valuestring or null<= 255 characters
realestatesArray of objects(Realestate)
profile_pictureobject or null
active_tostring or null(date-time)
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

invoice_distribution_instructionArray of objects or null
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"
fmistring or null[ 17 .. 20 ] characters
org_nostring or null(luhn)[ 10 .. 11 ] characters
invoice_addressobject or null(Address)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
prefer_invoice_view_onlyboolean
organizationobject or null(Organization)
show_in_brf_contextboolean
block_sms_notifications_forArray of objects
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
is_activeboolean
previous_addressobject or null(Address)
wants_evictedboolean
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
]
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/tenant/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 '[
    {
      "block_notifications_for": [
        null
      ],
      "autogiro_disables_invoice_distribution": true,
      "birth_date": "2019-08-24",
      "send_out_distribution_instruction": [
        null
      ],
      "ssn_is_coordination_number": true,
      "anonymization_name": "string",
      "reminder_distribution_instruction": [
        null
      ],
      "block_email_notifications_for": [
        null
      ],
      "gln13_number": "stringstrings",
      "ssn": "stringstring",
      "debt_distribution_instruction": [
        null
      ],
      "current_registered_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "allows_external_personal_information_sharing": true,
      "corporate_name": "string",
      "popular_name": "string",
      "future_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "anonymized": true,
      "first_name": "string",
      "custom_dimension_category_value": "string",
      "realestates": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        }
      ],
      "profile_picture": {
        "name": "string",
        "md5_hash": "string",
        "get": "string",
        "post": {
          "url": "string",
          "fields": {}
        }
      },
      "active_to": "2019-08-24T14:15:22Z",
      "last_name": "string",
      "invoice_distribution_instruction": [
        null
      ],
      "invoice_email": "user@example.com",
      "sni_number": "20.520",
      "fmi": "stringstringstrin",
      "org_no": "stringstri",
      "invoice_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "custom_id": "string",
      "custom_dimension_value": "string",
      "prefer_invoice_view_only": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "show_in_brf_context": true,
      "block_sms_notifications_for": [
        null
      ],
      "peppol_id": "stringstringstr",
      "is_active": true,
      "previous_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "wants_evicted": true,
      "email": "user@example.com",
      "phone_number": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

block_notifications_forArray of objects
autogiro_disables_invoice_distributionboolean
birth_datestring or null(date)
send_out_distribution_instructionArray of objects or null
ssn_is_coordination_numberboolean
anonymization_namestring or null<= 255 characters
full_nameanyread-only
reminder_distribution_instructionArray of objects or null
block_email_notifications_forArray of objects
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
ssnstring or null(luhn)[ 12 .. 13 ] characters
tagsanyread-only
mfa_has_hotpboolean or nullread-only
debt_distribution_instructionArray of objects or null
current_registered_addressobject or null(Address)
customer_columnsanyread-only
allows_external_personal_information_sharingboolean or null
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

popular_namestring or null<= 255 characters
latest_active_datestring or null(date)read-only
future_addressobject or null(Address)
anonymizedboolean
email_verifiedbooleanread-only
custom_application_domainstring or null<= 255 charactersread-only
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

custom_dimension_category_valuestring or null<= 255 characters
created_atstring(date-time)read-only
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

realestatesArray of objects(Realestate)
last_loginstring or null(date-time)read-only
profile_pictureobject or null
active_tostring or null(date-time)
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

invoice_distribution_instructionArray of objects or null
pending_monitor_approval_amountanyread-only
invoice_emailstring or null(email)<= 254 characters
mfa_has_totpboolean or nullread-only
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"
fmistring or null[ 17 .. 20 ] characters
phone_number_verifiedbooleanread-only
hotp_invite_sendout_timestring or null(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
invoice_addressobject or null(Address)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
prefer_invoice_view_onlyboolean
organizationobject or null(Organization)
show_in_brf_contextboolean
is_companyanyread-only
block_sms_notifications_forArray of objects
earliest_active_datestring or null(date)read-only
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
is_activeboolean
previous_addressobject or null(Address)
wants_evictedboolean
communication_nameanyread-only
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
]
Response
application/json
[
  {
    "block_notifications_for": [ … ],
    "autogiro_disables_invoice_distribution": true,
    "birth_date": "2019-08-24",
    "send_out_distribution_instruction": [ … ],
    "ssn_is_coordination_number": true,
    "anonymization_name": "string",
    "full_name": null,
    "reminder_distribution_instruction": [ … ],
    "block_email_notifications_for": [ … ],
    "gln13_number": "stringstrings",
    "ssn": "stringstring",
    "tags": null,
    "mfa_has_hotp": true,
    "debt_distribution_instruction": [ … ],
    "current_registered_address": { … },
    "customer_columns": null,
    "allows_external_personal_information_sharing": true,
    "corporate_name": "string",
    "popular_name": "string",
    "latest_active_date": "2019-08-24",
    "future_address": { … },
    "anonymized": true,
    "email_verified": true,
    "custom_application_domain": "string",
    "first_name": "string",
    "custom_dimension_category_value": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "username": "stringst",
    "realestates": [ … ],
    "last_login": "2019-08-24T14:15:22Z",
    "profile_picture": { … },
    "active_to": "2019-08-24T14:15:22Z",
    "last_name": "string",
    "invoice_distribution_instruction": [ … ],
    "pending_monitor_approval_amount": null,
    "invoice_email": "user@example.com",
    "mfa_has_totp": true,
    "sni_number": "20.520",
    "fmi": "stringstringstrin",
    "phone_number_verified": true,
    "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
    "org_no": "stringstri",
    "invoice_address": { … },
    "custom_id": "string",
    "custom_dimension_value": "string",
    "prefer_invoice_view_only": true,
    "status": 0,
    "organization": { … },
    "show_in_brf_context": true,
    "is_company": null,
    "block_sms_notifications_for": [ … ],
    "earliest_active_date": "2019-08-24",
    "peppol_id": "stringstringstr",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_active": true,
    "previous_address": { … },
    "wants_evicted": true,
    "communication_name": null,
    "email": "user@example.com",
    "phone_number": "string"
  }
]

List 'Tenant'

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

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_dimension_category_valueany

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_dimension_valueany

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

show_in_brf_contextany

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/tenant/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 [
statusinteger(int32)[ -2147483648 .. 2147483647 ]read-onlyrequired
Enum0123456789
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

block_notifications_forArray of objects
autogiro_disables_invoice_distributionboolean
birth_datestring or null(date)
send_out_distribution_instructionArray of objects or null
ssn_is_coordination_numberboolean
anonymization_namestring or null<= 255 characters
full_nameanyread-only
reminder_distribution_instructionArray of objects or null
block_email_notifications_forArray of objects
gln13_numberstring or null(gln13)[ 13 .. 14 ] characters
ssnstring or null(luhn)[ 12 .. 13 ] characters
tagsanyread-only
mfa_has_hotpboolean or nullread-only
debt_distribution_instructionArray of objects or null
current_registered_addressobject or null(Address)
customer_columnsanyread-only
allows_external_personal_information_sharingboolean or null
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

popular_namestring or null<= 255 characters
latest_active_datestring or null(date)read-only
future_addressobject or null(Address)
anonymizedboolean
email_verifiedbooleanread-only
custom_application_domainstring or null<= 255 charactersread-only
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

custom_dimension_category_valuestring or null<= 255 characters
created_atstring(date-time)read-only
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

realestatesArray of objects(Realestate)
last_loginstring or null(date-time)read-only
profile_pictureobject or null
active_tostring or null(date-time)
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

invoice_distribution_instructionArray of objects or null
pending_monitor_approval_amountanyread-only
invoice_emailstring or null(email)<= 254 characters
mfa_has_totpboolean or nullread-only
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"
fmistring or null[ 17 .. 20 ] characters
phone_number_verifiedbooleanread-only
hotp_invite_sendout_timestring or null(date-time)read-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
invoice_addressobject or null(Address)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
prefer_invoice_view_onlyboolean
organizationobject or null(Organization)
show_in_brf_contextboolean
is_companyanyread-only
block_sms_notifications_forArray of objects
earliest_active_datestring or null(date)read-only
peppol_idstring or null[ 15 .. 18 ] characters'^(0007|0088):\d{10,13}$'
is_activeboolean
previous_addressobject or null(Address)
wants_evictedboolean
communication_nameanyread-only
emailstring or null(email)<= 254 characters
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
]
Response
application/json
[
  {
    "block_notifications_for": [ … ],
    "autogiro_disables_invoice_distribution": true,
    "birth_date": "2019-08-24",
    "send_out_distribution_instruction": [ … ],
    "ssn_is_coordination_number": true,
    "anonymization_name": "string",
    "full_name": null,
    "reminder_distribution_instruction": [ … ],
    "block_email_notifications_for": [ … ],
    "gln13_number": "stringstrings",
    "ssn": "stringstring",
    "tags": null,
    "mfa_has_hotp": true,
    "debt_distribution_instruction": [ … ],
    "current_registered_address": { … },
    "customer_columns": null,
    "allows_external_personal_information_sharing": true,
    "corporate_name": "string",
    "popular_name": "string",
    "latest_active_date": "2019-08-24",
    "future_address": { … },
    "anonymized": true,
    "email_verified": true,
    "custom_application_domain": "string",
    "first_name": "string",
    "custom_dimension_category_value": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "username": "stringst",
    "realestates": [ … ],
    "last_login": "2019-08-24T14:15:22Z",
    "profile_picture": { … },
    "active_to": "2019-08-24T14:15:22Z",
    "last_name": "string",
    "invoice_distribution_instruction": [ … ],
    "pending_monitor_approval_amount": null,
    "invoice_email": "user@example.com",
    "mfa_has_totp": true,
    "sni_number": "20.520",
    "fmi": "stringstringstrin",
    "phone_number_verified": true,
    "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
    "org_no": "stringstri",
    "invoice_address": { … },
    "custom_id": "string",
    "custom_dimension_value": "string",
    "prefer_invoice_view_only": true,
    "status": 0,
    "organization": { … },
    "show_in_brf_context": true,
    "is_company": null,
    "block_sms_notifications_for": [ … ],
    "earliest_active_date": "2019-08-24",
    "peppol_id": "stringstringstr",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_active": true,
    "previous_address": { … },
    "wants_evicted": true,
    "communication_name": null,
    "email": "user@example.com",
    "phone_number": "string"
  }
]

Organizationuser

Operations

Subtenant

Operations

Organizationuserworkengagement

Operations

Organizationusersegment

Operations

Integrationuseragent

Operations

Protectedidentity

Operations

Workengagement

Operations
© Pigello. All rights reserved.