filestorage/groups

Retrieve Groups

Retrieve Groups from any connected Filestorage software

get/filestorage/groups/{id}

Path parameters

idstring required

id of the permission you want to retrieve.

Query parameters

remote_databoolean

Set to true to include data from the original File Storage software.

Headers

x-connection-tokenstring required

The connection token

Response

namestring nullable required

The name of the group

remote_was_deletedboolean nullable required

Indicates whether or not this object has been deleted in the third party platform.

field_mappingsobject nullable

The custom field mappings of the object between the remote 3rd party & Panora

idstring nullable

The UUID of the group

remote_idstring nullable

The id of the group in the context of the 3rd Party

remote_dataobject nullable

The remote data of the group in the context of the 3rd Party

created_atstring date-time nullable

The created date of the object

modified_atstring date-time nullable

The modified date of the object

Example response

{
  "name": "My group",
  "users": [
    "801f9ede-c698-4e66-a7fc-48d19eebaa4f"
  ],
  "field_mappings": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
  "remote_id": "id_1",
  "remote_data": {
    "fav_dish": "broccoli",
    "fav_color": "red"
  },
  "created_at": "2024-10-01T12:00:00Z",
  "modified_at": "2024-10-01T12:00:00Z"
}

Changes

Changed in 5 of the 18 revisions of this API.327

    • ▲

      added subschema #1 to the / response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      the / response's property type changed from string to no type for status

      response-property-type-changed

  • ca213ae36b7f141See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ▲

      the response's property type changed from string to object, and format from date-time to no format for status

      response-property-type-changed

    • ▲

      the response's property type changed from string to object, and format from date-time to no format for status

      response-property-type-changed

    • ○

      the endpoint scheme security bearer was added to the API

      api-security-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    • ▲

      the response's property type changed from object to string, and format from no format to date-time for status

      response-property-type-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the endpoint scheme security bearer was removed from the API

      api-security-removed