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

Create 'Organizationuserworkengagement'

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
userobject(Organizationuser)required
user.​idstring(uuid)
work_engagementobject(Workengagement)required
work_engagement.​idstring(uuid)
end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

outdoor_areasArray of objects(Outdoorarea)
dates_are_blockingboolean or null
buildingsArray of objects(Building)
organizationobject or null(Organization)
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

parking_lotsArray of objects(Parkinglot)
receive_notifications_forArray of objects
custom_idstring or null<= 128 characters
curl -i -X POST \
  https://dev.api.pigello.io/accounts/users/organization/organizationuserworkengagement/ \
  -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 '{
    "end_date": "2019-08-24",
    "outdoor_areas": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "dates_are_blocking": true,
    "buildings": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "receive_email_notifications_for": [
      null
    ],
    "receive_sms_notifications_for": [
      null
    ],
    "start_date": "2019-08-24",
    "parking_lots": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "receive_notifications_for": [
      null
    ],
    "work_engagement": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string"
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

userobject(Organizationuser)required
user.​idstring(uuid)
work_engagementobject(Workengagement)required
work_engagement.​idstring(uuid)
end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

outdoor_areasArray of objects(Outdoorarea)
dates_are_blockingboolean or null
buildingsArray of objects(Building)
organizationobject or null(Organization)
created_atstring(date-time)read-only
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

parking_lotsArray of objects(Parkinglot)
receive_notifications_forArray of objects
custom_idstring or null<= 128 characters
Response
application/json
{
  "end_date": "2019-08-24",
  "outdoor_areas": [
    { … }
  ],
  "dates_are_blocking": true,
  "buildings": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "receive_email_notifications_for": [
    null
  ],
  "receive_sms_notifications_for": [
    null
  ],
  "start_date": "2019-08-24",
  "parking_lots": [
    { … }
  ],
  "receive_notifications_for": [
    null
  ],
  "work_engagement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string"
}

Update 'Organizationuserworkengagement'

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
userobject(Organizationuser)required
user.​idstring(uuid)
work_engagementobject(Workengagement)required
work_engagement.​idstring(uuid)
end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

outdoor_areasArray of objects(Outdoorarea)
dates_are_blockingboolean or null
buildingsArray of objects(Building)
organizationobject or null(Organization)
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

parking_lotsArray of objects(Parkinglot)
receive_notifications_forArray of objects
custom_idstring or null<= 128 characters
curl -i -X PATCH \
  'https://dev.api.pigello.io/accounts/users/organization/organizationuserworkengagement/{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 '{
    "end_date": "2019-08-24",
    "outdoor_areas": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "dates_are_blocking": true,
    "buildings": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "user": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "receive_email_notifications_for": [
      null
    ],
    "receive_sms_notifications_for": [
      null
    ],
    "start_date": "2019-08-24",
    "parking_lots": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "receive_notifications_for": [
      null
    ],
    "work_engagement": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string"
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

userobject(Organizationuser)required
user.​idstring(uuid)
work_engagementobject(Workengagement)required
work_engagement.​idstring(uuid)
end_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: start_date

outdoor_areasArray of objects(Outdoorarea)
dates_are_blockingboolean or null
buildingsArray of objects(Building)
organizationobject or null(Organization)
created_atstring(date-time)read-only
receive_email_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

receive_sms_notifications_forArray of objects

Additional Validation Information:

This value must match with the values of these fields: receive_notifications_for

start_datestring or null(date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: end_date

parking_lotsArray of objects(Parkinglot)
receive_notifications_forArray of objects
custom_idstring or null<= 128 characters
Response
application/json
{
  "end_date": "2019-08-24",
  "outdoor_areas": [
    { … }
  ],
  "dates_are_blocking": true,
  "buildings": [
    { … }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "receive_email_notifications_for": [
    null
  ],
  "receive_sms_notifications_for": [
    null
  ],
  "start_date": "2019-08-24",
  "parking_lots": [
    { … }
  ],
  "receive_notifications_for": [
    null
  ],
  "work_engagement": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string"
}

Delete 'Organizationuserworkengagement'

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 DELETE \
  'https://dev.api.pigello.io/accounts/users/organization/organizationuserworkengagement/{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 deletion

Response
No content

Organizationusersegment

Operations

Integrationuseragent

Operations

Protectedidentity

Operations

Workengagement

Operations
© Pigello. All rights reserved.