Skip to main content
GET
/
v1
/
custom-properties
/
groups
List custom property groups
curl --request GET \
  --url https://api.light.inc/v1/custom-properties/groups \
  --header 'Authorization: <api-key>'
{
  "total": 123,
  "records": [
    {
      "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.

Query Parameters

​
sort
string
Example:

"amount:desc,createdAt:asc"

​
filter
string
Example:

"state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500"

​
limit
integer
​
offset
integer
​
searchTerm
string
​
includeValues
boolean

Response

default - application/json;charset=UTF-8

default response

​
total
integer
​
records
object[]
⌘I