Skip to main content
GET
/
api
/
v2
/
types
List Types
curl --request GET \
  --url https://api.example.com/api/v2/types \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "Types fetched successfully.",
  "data": [
    {
      "uuid": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "name": "Tote Bags",
      "description": "Large carry-all bags",
      "category_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "active": true
    },
    {
      "uuid": "d4e5f6a7-b8c9-0123-defa-456789012345",
      "name": "Luxury Watches",
      "description": "High-end timepieces",
      "category_uuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "active": true
    }
  ],
  "metadata": {
    "total_count": 2,
    "page_number": 1,
    "total_pages": 1,
    "page_size": 20
  }
}

Authorizations

x-api-key
string
header
required

API key for application authentication (format: leo_xxxxxxxxx)

Query Parameters

page_size
integer
default:20

Number of results per page

Required range: 1 <= x <= 100
page_number
integer
default:1

Page number

Required range: x >= 1
search_query
string

Search term for type names

activeOnly
boolean
default:false

Filter to only active types

Response

200 - application/json

Types retrieved successfully

The response is of type any.