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

Workengagement

Operations

Get 'Workengagement'

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/organization/workengagement/{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

namestring<= 255 charactersrequired
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
template_notificationsArray of objects or null
tagsanyread-only
color_codestring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'
created_atstring(date-time)read-only
template_sms_notificationsArray of objects or null
template_email_notificationsArray of objects or null
customer_columnsanyread-only
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "template_notifications": [
    null
  ],
  "tags": null,
  "color_code": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "template_sms_notifications": [
    null
  ],
  "template_email_notifications": [
    null
  ],
  "customer_columns": null,
  "name": "string"
}

Delete 'Workengagement'

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/workengagement/{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

Update 'Workengagement'

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
namestring<= 255 charactersrequired
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
template_notificationsArray of objects or null
color_codestring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'
template_sms_notificationsArray of objects or null
template_email_notificationsArray of objects or null
curl -i -X PATCH \
  'https://dev.api.pigello.io/accounts/users/organization/workengagement/{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 '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "template_notifications": [
      null
    ],
    "color_code": "string",
    "template_sms_notifications": [
      null
    ],
    "template_email_notifications": [
      null
    ],
    "name": "string"
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring<= 255 charactersrequired
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
template_notificationsArray of objects or null
tagsanyread-only
color_codestring or null<= 7 characters'^(?:[0-9a-fA-F]{3}){1,2}$'
created_atstring(date-time)read-only
template_sms_notificationsArray of objects or null
template_email_notificationsArray of objects or null
customer_columnsanyread-only
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "template_notifications": [
    null
  ],
  "tags": null,
  "color_code": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "template_sms_notifications": [
    null
  ],
  "template_email_notifications": [
    null
  ],
  "customer_columns": null,
  "name": "string"
}
© Pigello. All rights reserved.