Skip to main content
GET
/
v1
/
custom-properties
/
groups
/
{groupId}
Get custom property group
curl --request GET \
  --url https://api.light.inc/v1/custom-properties/groups/{groupId} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "internalName": "<string>",
  "inputType": "SINGLE_SELECT",
  "objectLevel": "HEADER",
  "objectTypes": [
    "BILL"
  ],
  "objectTypeStatuses": {},
  "context": "<string>",
  "values": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupInternalName": "<string>",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "internalName": "<string>",
      "label": "<string>",
      "context": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "required": true
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

Path Parameters

​
groupId
string<uuid>
required

Response

default - application/json;charset=UTF-8

default response

List of records for the current page

​
id
string<uuid>
​
companyId
string<uuid>
​
label
string
​
internalName
string
​
inputType
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
SINGLE_SELECT,
MULTI_SELECT,
NUMERIC,
TEXT,
BOOLEAN,
DATE
​
objectLevel
enum<string>

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
HEADER,
LINE
​
objectTypes
enum<string>[]

⚠️ This enum is not exhaustive; new values may be added in the future.

Available options:
BILL,
CARD_TRANSACTION,
CREDIT_NOTE,
CONTRACT,
CUSTOMER,
CUSTOMER_CREDIT,
INVOICE,
JOURNAL_ENTRY,
PRODUCT,
PURCHASE_ORDER,
REIMBURSEMENT,
VENDOR
​
objectTypeStatuses
object
​
context
string
​
values
object[]
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
required
boolean