List Properties

Beta

GET/v1/catalog/properties

This endpoint is idempotent. Learn more

Returns a paginated list of properties for the target account.

cursoroptional string

Cursor token used to retrieve the next or previous page of results.

limitoptional integer

Maximum number of results per page (default: 100, max: 1000).

qoptional string

Search query used to filter results.

include[]optional arrayenumValues:attributes

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name.

attributesobjectExpandablenullable

Attributes belonging to this property.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

Attribute value.

colorstringenumValues:bluebrowndefault

Color code.

sort_orderinteger

Display order.

propertyobjectnullable

Property this attribute belongs to (set when the attribute is returned under item.attributes).

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for List Properties

List Properties

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listProperty = await client.catalog.properties.list();

console.log(listProperty.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listProperty = await client.catalog.properties.list();

console.log(listProperty.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/catalog/properties?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicHBfMDFlMjEzNDQ4NzgwNjQzNzJmNjllNjcwOTMiLCJkIjoiZiJ9.Z7iSFNVdx3ccbyPgjrt9m8-FoSq7DWf8QOSFjuAyszI",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "pp_01e21344878064372f69e67093",
      "object": "property",
      "name": "Color",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/catalog/properties?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoicHBfMDFlMjEzNDQ4NzgwNjQzNzJmNjllNjcwOTMiLCJkIjoiZiJ9.Z7iSFNVdx3ccbyPgjrt9m8-FoSq7DWf8QOSFjuAyszI",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "pp_01e21344878064372f69e67093",
      "object": "property",
      "name": "Color",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Properties

Query Parameters

Returns

Responses