v1

latestOpenAPI 3.1.02026-07-24257573.4 KB

Menus

Retrieve Menus

This operation will retrieve all Menus that are linked to the Integrated Partner.

You can use the sort and filter query parameters to refine the results and locate specific Menus.

💡 Tip 💡

The Menu response includes a nested organization object.

You can use its id field (organization.id) with the filters[organization_id] query parameter to fetch all Menus belonging to that Organization.

get/menus

Query parameters

page_sizeinteger

Number of items per page for paginated lists. Maximum 150.

sort[]string[]

Optionally return resources in a specified order. Use a '-' to invert order.

filters[eligibility]'static' | 'express'

Filter menus that are eligible to be assigned as this feature

filters[items_count][above]integer

Filter menus that have an items_count above this number

filters[items_count][below]integer

Filter menus that have an items_count below this number

filters[name][eq]string

Filter resources where name equals; cannot be combined with match

filters[name][match]string

Filter resources where name contains; cannot be combined with eq

filters[organization_id]integer

Filter menus belonging to this organization_id

filters[updated_at][after]string date-time

Filter resources after the updated_at timestamp

filters[updated_at][before]string date-time

Filter resources before the updated_at timestamp

Response

Successful Menus Retrieval

Example response

{
  "data": [
    {
      "id": 420,
      "items_count": 72,
      "name": "Purple Urkle",
      "organization": {
        "id": 420,
        "name": "Purple Urkle"
      },
      "updated_at": "2023-04-20T16:20:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 42
  }
}