List custom properties

Retrieve all custom properties previously created.

GET /v1/custom-properties

List custom properties

cURL

curl --request GET \
  --url https://api.hyperline.co/v1/custom-properties \
  --header 'Authorization: Bearer <token>'

200

{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "cfi_efnjehRH304",
      "name": "Test custom property",
      "slug": "test_custom_property",
      "entities": [],
      "authorized_values": [
        "<string>"
      ],
      "created_at": "2024-01-01T22:00:00Z",
      "updated_at": "2024-01-01T22:00:00Z",
      "api_only": false
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

meta · object · required

Show child attributes

data · object[] · required

List of CustomProperty.

Show child attributes