GET
/
ext
/
v1
/
entities
Gets company entities, supporting filtering, sorting, searching, and pagination
curl --request GET \
  --url https://api.light.inc/rest/ext/v1/entities
{
  "total": 123,
  "records": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "code": "<string>",
      "parentCompanyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "localCurrency": "USD",
      "displayName": "<string>",
      "vatNumber": "<string>",
      "name": "<string>",
      "address": {
        "country": "UNDEFINED",
        "city": "<string>",
        "state": "<string>",
        "zipcode": "<string>",
        "street": "<string>",
        "street2": "<string>"
      },
      "status": "ACTIVE",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

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
​
includeCardCustomer
boolean

Response

default - application/json;charset=UTF-8

default response

The response is of type object.