Custom properties
Get custom properties
- Documentation
- API Reference
- Integrations
- Changelog
- Blog
- GETGet analytics
- GETGet companies
- GETGet custom properties
- POSTCreate custom property
- PUTUpdate custom property
- DELDelete custom property
- GETGet customers
- POSTCreate customer
- GETGet customer
- PUTUpdate customer
- DELDelete customer
- GETGet customer portal
- PUTArchive customer
- POSTBulk update providers/customers mapping
- GETList credit products
- POSTCreate credit product
- GETGet credit product
- GETList credit transactions
- POSTPurchase credits
- POSTTopup credits
- POSTCreate credits usage
- POSTCreate component token
- GETGet invoices
- POSTCreate one-off invoice
- POSTSends a draft invoice for payment
- GETGet invoice
- GETDownload invoice
- POSTCreate transaction
- GETGet invoicing entities
- POSTCreate invoicing entity
- GETGet invoicing entity
- PUTUpdate invoicing entity
- DELDelete invoicing entity
- POSTCreate payment
- POSTUpdate prices
- POSTRefresh subscriptions
- POSTCreate subscription update
- POSTCancel subscription
- POSTPause subscription
- POSTReactivate subscription
- GETGet subscriptions
- POSTCreate subscription
- GETGet subscription
- POSTRefresh seat products
Analytics
Companies
Custom properties
Customers
Customers > Credits
Integrations
Invoices
Invoicing entities
Payments
Price configurations
Subscriptions
Custom properties
Get custom properties
Retrieve all custom properties previously created.
GET
/
v1
/
custom-properties
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
curl --request GET \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "cfi_efnjehRH304",
"name": "Test custom property",
"slug": "test_custom_property",
"type": "date",
"entities": [
"customer"
],
"authorized_values": [
"<string>"
],
"api_only": true,
"created_at": "2024-01-01T22:00:00Z",
"updated_at": "2024-01-01T22:00:00Z"
}
]
}Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
200 - application/json
meta
object
requiredmeta.total
number
requiredTotal of existing items.
meta.taken
number
requiredNumber of items returned.
meta.skipped
number
requiredNumber of items skipped.
data
object[]
requiredList of CustomProperty.
data.id
string
requiredCustom property ID.
data.name
string
requiredCustom property name.
data.slug
string
requiredCustom property unique slug.
data.type
enum<string>
requiredCustom property type.
Available options:
date, boolean, number, text, select data.entities
enum<string>[]
requiredEntities on which the custom property is available.
Available options:
customer, subscription, product, plan data.authorized_values
string[] | null
requiredIf the custom property is of type select this is the list of available values.
data.api_only
boolean
default: falserequiredIf true the custom property will not be displayed in the interface.
data.created_at
string
requiredCreation date of the custom property.
data.updated_at
string
requiredUpdate date of the custom property.
curl --request GET \
--url https://api.hyperline.co/v1/custom-properties \
--header 'Authorization: Bearer <token>'{
"meta": {
"total": 1,
"taken": 1,
"skipped": 123
},
"data": [
{
"id": "cfi_efnjehRH304",
"name": "Test custom property",
"slug": "test_custom_property",
"type": "date",
"entities": [
"customer"
],
"authorized_values": [
"<string>"
],
"api_only": true,
"created_at": "2024-01-01T22:00:00Z",
"updated_at": "2024-01-01T22:00:00Z"
}
]
}