filestorage/groups

Retrieve Groups

Changed on

Retrieve Groups from any connected Filestorage software

get/filestorage/groups/{id}

Request

  • Base URL
    https://api.panora.dev
  • URL
    https://api.panora.dev/filestorage/groups/{id}
  • Auth
    API key in header x-api-key

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

  • 6502b0fa098cRevision changes
    • breaking

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

    • breaking

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

  • ca213ae36b7fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

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

    • breaking

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

    • info

      the endpoint scheme security bearer was removed from the API