Skip to content

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

Organizationuserworkengagement

Operations

Organizationusersegment

Operations

Integrationuseragent

Operations

Protectedidentity

Operations

Bulk write 'Protectedidentity'

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 [
tenantobject or null(Tenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: sub_tenant

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

last_namestring or null<= 255 characters
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters
previous_addressobject or null(Address)
sub_tenantobject or null(Subtenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: tenant

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

future_addressobject or null(Address)
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
custom_idstring or null<= 128 characters
birth_datestring or null(date)
first_namestring or null<= 255 characters
current_registered_addressobject or null(Address)
ssnstring or null(luhn)[ 12 .. 13 ] characters
]
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/customer/protectedidentity/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 '[
    {
      "tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "last_name": "string",
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "email": "user@example.com",
      "previous_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "sub_tenant": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "future_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "phone_number": "string",
      "custom_id": "string",
      "birth_date": "2019-08-24",
      "first_name": "string",
      "current_registered_address": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "ssn": "stringstring"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantobject or null(Tenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: sub_tenant

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

last_namestring or null<= 255 characters
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters
previous_addressobject or null(Address)
sub_tenantobject or null(Subtenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: tenant

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

future_addressobject or null(Address)
created_atstring(date-time)read-only
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
custom_idstring or null<= 128 characters
birth_datestring or null(date)
first_namestring or null<= 255 characters
current_registered_addressobject or null(Address)
ssnstring or null(luhn)[ 12 .. 13 ] characters
]
Response
application/json
[
  {
    "tenant": { … },
    "last_name": "string",
    "organization": { … },
    "email": "user@example.com",
    "previous_address": { … },
    "sub_tenant": { … },
    "future_address": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "phone_number": "string",
    "custom_id": "string",
    "birth_date": "2019-08-24",
    "first_name": "string",
    "current_registered_address": { … },
    "ssn": "stringstring"
  }
]

List 'Protectedidentity'

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
global_realestatesArray of objects
global_segmentsArray of objects
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

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_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

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

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

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

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

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

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

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

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

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

sub_tenantany

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

tenantany

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/protectedidentity/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 [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantobject or null(Tenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: sub_tenant

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

last_namestring or null<= 255 characters
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters
previous_addressobject or null(Address)
sub_tenantobject or null(Subtenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: tenant

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

future_addressobject or null(Address)
created_atstring(date-time)read-only
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
custom_idstring or null<= 128 characters
birth_datestring or null(date)
first_namestring or null<= 255 characters
current_registered_addressobject or null(Address)
ssnstring or null(luhn)[ 12 .. 13 ] characters
]
Response
application/json
[
  {
    "tenant": { … },
    "last_name": "string",
    "organization": { … },
    "email": "user@example.com",
    "previous_address": { … },
    "sub_tenant": { … },
    "future_address": { … },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "phone_number": "string",
    "custom_id": "string",
    "birth_date": "2019-08-24",
    "first_name": "string",
    "current_registered_address": { … },
    "ssn": "stringstring"
  }
]

Get 'Protectedidentity'

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
curl -i -X GET \
  'https://dev.api.pigello.io/accounts/users/customer/protectedidentity/{pk}/' \
  -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 selection

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

tenantobject or null(Tenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: sub_tenant

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

last_namestring or null<= 255 characters
organizationobject or null(Organization)
emailstring or null(email)<= 254 characters
previous_addressobject or null(Address)
sub_tenantobject or null(Subtenant)

Additional Validation Information:

Must be unique

This value can't bet set, when any of the following fields are set: tenant

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

future_addressobject or null(Address)
created_atstring(date-time)read-only
phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
custom_idstring or null<= 128 characters
birth_datestring or null(date)
first_namestring or null<= 255 characters
current_registered_addressobject or null(Address)
ssnstring or null(luhn)[ 12 .. 13 ] characters
Response
application/json
{
  "tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "last_name": "string",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "email": "user@example.com",
  "previous_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "sub_tenant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "future_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "created_at": "2019-08-24T14:15:22Z",
  "phone_number": "string",
  "custom_id": "string",
  "birth_date": "2019-08-24",
  "first_name": "string",
  "current_registered_address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "ssn": "stringstring"
}

Workengagement

Operations
© Pigello. All rights reserved.