Skip to main content
GET
/
sections
Get Sections
curl --request GET \
  --url https://api.partoo.co/v2/sections \
  --header 'x-APIKey: <api-key>'
{
  "page": 1,
  "count": 6,
  "max_page": 1,
  "sections": [
    {
      "id": 1,
      "name": "Country",
      "groups": [
        {
          "id": 123,
          "name": "<string>",
          "has_puller": true,
          "business_count": 123
        }
      ],
      "can_edit": true,
      "has_puller": true
    }
  ]
}

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.

Query Parameters

​
page
integer
default:1

Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.

​
org_id
integer

Filter by organization ID. Only PROVIDER users can use this filter. If you are not a PROVIDER, this will default to the ID of your organization.

​
group_name_query
string

Filter sections to only those containing at least one group whose name contains this value (case-insensitive substring match).

Response

OK

​
page
integer
Example:

1

​
count
integer
Example:

6

​
max_page
integer
Example:

1

​
sections
object[]