Light APIv1.0.0

API / Reference / Custom Properties

Get custom property group

GET https://api.light.inc/v1/custom-properties/groups/{groupId}

Returns a custom property group by ID

Always includes values, restricted to active values. A group that was deleted in Light still answers 200 (see the list endpoint for how to tell); only groups your company defined are visible, everything else is 404 CUSTOM_PROPERTY_GROUP_NOT_FOUND.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

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

  • Bearer token

Path parameters

  • groupId string · uuidrequired

Response

  • id string · uuid

  • companyId string · uuid

  • label string

  • internalName string

  • inputType string

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

    One of SINGLE_SELECT MULTI_SELECT NUMERIC TEXT BOOLEAN DATE

  • objectLevel string

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

    One of HEADER LINE

  • objectTypes array of string

    One of BILL CARD_TRANSACTION CREDIT_NOTE CONTRACT CUSTOMER CUSTOMER_CREDIT INVOICE JOURNAL_ENTRY LEDGER_ACCOUNT PRODUCT PURCHASE_ORDER PURCHASE_REQUEST REIMBURSEMENT VENDOR

  • objectTypeStatuses object

    A map of record type to ACTIVE or DELETED. This is how a deleted group shows up: there is no status field, and a group deleted in Light has every entry set to DELETED yet is still listed.

  • isRequired boolean

  • context string

  • values array of object

    null when not requested (includeValues is off on the list endpoint). [] when requested and the group has no active values, or when the catalogue exceeds the 15,000-value hydration cap; page through GET .../groups/{groupId}/values in that case.

    • id string · uuid

      Unique identifier for the object

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • companyId string · uuid

      ID of the company

    • internalName string

      Internal name of the custom property value

    • label string

      Label of the custom property value

    • context string

      Context/description of the custom property value

    • createdAt string · date-time

      Timestamp when the custom property value was created

    • updatedAt string · date-time

      Timestamp when the custom property value was last updated

  • createdAt string · date-time

  • updatedAt string · date-time