List enterprises
Lists the enterprises your integration key can reach.
Find an enterprise by your own reference with external_ref, or by
name or registration number with q.
integrationKeyAuthorizationBearer <token>Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>.
Konsol issues it.
page?integer1 <= value1limit?integer1 <= value <= 10020q?stringSearches by name, folded to a normalized form: case, punctuation, diacritics
and whitespace collapsed, with legal-form spellings such as Sdn. Bhd.,
S/B and Sendirian Berhad treated as equivalent. Every word in the query
must match. Also matches business_reg_no as a case-insensitive substring.
% and _ carry no wildcard meaning. 2–128 characters.
2 <= length <= 128match?stringnormalized (default) matches name folded as q describes. literal
matches the raw values with a case-insensitive substring.
"normalized""normalized""literal"sort?stringOrders by a field, ascending, or descending with a - prefix. Ties break on
id. Without it the list is in id order, or in updated_at order when
you send updated_after. sort=updated_at leaves out changes from the last
30 seconds, as updated_after describes; sort=-updated_at does not.
"created_at""-created_at""updated_at""-updated_at""name""-name"external_ref?stringYour identifier, matched exactly.
^\S(.*\S)?$1 <= length <= 128status?string"active""inactive"business_reg_no?stringlength <= 12include_deleted?booleanWith true, deleted records are returned too, with deleted_at set. Use it
with sort=updated_at to sync deletions.
falseupdated_after?stringReturns records changed after this time, in sort=updated_at order. Any
other sort, including -updated_at, is a 400. Send a record's
updated_at exactly as you received it. With updated_after or
sort=updated_at, changes from the last 30 seconds are left out until they
are saved, so a sync never skips one.
date-timeupdated_after_id?stringSent with updated_after, from the same record; without updated_after it
is a 400. Among records changed at exactly updated_after, returns only
those after this id.
uuidA page of enterprises
application/json- response
data*array<>page*integer1 <= valuelimit*integer1 <= value <= 100total_count*integer0 <= valuetotal_is_capped*booleantotal_pages*integer0 <= valuehas_more*booleancurl -X GET 'https://api.konsol.my/integration/v1/enterprises'{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "external_ref": "ACQ-MBB", "name": "string", "status": "active", "business_reg_no": "string", "address": { "line1": "string", "line2": "string", "city": "string", "postcode": "string", "state": "MY-01", "country": "MY" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ], "page": 1, "limit": 1, "total_count": 0, "total_is_capped": true, "total_pages": 0, "has_more": true}