PApartoo
Groups and Sections

Get Group

Get a group and it's associated business IDs.
For more information about the group system, see the Groups and Sections description.

get/sections/{section_id}/groups/{group_id}

Request

Path parameters

section_idinteger required

Section ID

group_idinteger required

Group ID

Response

OK

idinteger

ID of the group

namestring

Name of the group, must be unique

has_pullerboolean

If the group is linked to a puller. If so, it's not possible to delete the group. Should you want to make any changes to a group connected to a puller, please contact support for assistance.

business_idsBusinessId[]

list of business ids in the group

Example response

{
  "id": 1,
  "name": "France",
  "business_ids": [
    "a1f0e2d3b4c5e6f7a8b9c0d1",
    "3f2e1d4c5b6a7f8e9d0c1a2",
    "0e1d2c3b4a5f6e7d8c9a0b1"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.