Skip to main content
GET
Get Group

Authorizations

x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

section_id
integer
required

Section ID

group_id
integer
required

Group ID

Response

OK

id
integer

ID of the group

Example:

1

name
string

Name of the group, must be unique

Example:

"France"

has_puller
boolean

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_ids
string[]

list of business ids in the group

Business id

Example: