Get Org Entities

get

https://{host}/v1.1/organization/entities

Retrieves the details of zones, stores, store servers, concepts or TILLs configured for the current organization. By default, it fetches up to 200 entities.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

type

string

enum

required

Type of entity to retrieve.

Allowed:

int64

Pass an entity id as in the org_entities table (in database) to get the details of that particular entity. For example, ?type=STORE&id=12354309To get the details of multiple entries, pass each ID separating with , . For example, “12859252,12859253”.

scope

string

enum

Pass STORE_CUSTOM_FIELDS or ZONE_CUSTOM_FIELDS to retrieve the list of store level or zone level custom fields.

Allowed:

parent_identifier_type

string

enum

Parent entity type to fetch its child entities

Allowed:

parent_identifier_value

string

Pass the respective identifier value.

include_parent

boolean

Pass true to retrieve the details of the parent entity (parent zone or concept). This is applicable only for type zone or concept. Sample - ?type=CONCEPT&id=50995&include_parent=true

sub_entities_count

int32

Limit the number of sub-entities to retrieve for each entity.

details

string

enum

Pass basic to see only basic information excluding currency, time-zone, and language information.

Allowed:

exclude_locale

string

enum

Defaults to 0

Pass 1 to exclude time zone details (timezones), 0 to retrieve timezones > base_timezone details of an entity.

Allowed:

start_id

int64

Fetches entities that are above the offset number you pass. Offset is the position of the entity in the db record. The value is assigned based on the sequence of creation. For example, start_id=10 retrieves all the entities from record number 11.

limit

int32

Defaults to 500

Limit the number of entities to retrieve.

modified_since

date

Retrieves the entities that are modified on or after a specific date.

active_only

boolean

Pass true to retrieve the list of only active stores.

language_translatons

boolean

format

string

enum

Preferred response format.

Allowed:

Responses

200200

400400