Find Category

Find matching SPATE categories by category name or partial category name.

Endpoint

GET /v1/latest/find-category/{name}

Authorization

Requires an API bearer token.

Authorization: Bearer <token>

Path parameters

Name	Type	Required	Description
name	string	Yes	Category name or partial category name to search for.

Response

Returns up to 100 category matches whose names contain the provided search text.

Field	Type	Description
name	string	The search text sent in the request.
categories	array	Matching categories, each { level, name, uuid }. level is one of cat1, cat2, cat3, cat4, cat5. Use uuid as the category_id of the category endpoints.
call_cost	integer	Credits charged for the call.
data_cost	integer	Credits charged for the returned data. Always 0 for this endpoint.

Example

Request

curl \
  -H "Authorization: Bearer $SPATE_API_TOKEN" \
  "https://api.spate.nyc/v1/latest/find-category/serum"

Response

200 OK

{
  "key":"/v1/2026w37/find-category/serum",
  "credits_used":100,
  "data":{
    "name":"serum",
    "categories": [
      {
        "level":"cat4",
        "name":"face serum products",
        "uuid":"d4d95c2e-9af3-456a-b32e-d2908c5e7c49"
      },
      {
        "level":"cat5",
        "name":"acne serum",
        "uuid":"12587809-4c22-4420-8555-637e375add88"
      },
      ...
    ],
    "call_cost":100,
    "data_cost":0
  }
}