List objects

extra_fields

array of strings

The extra fields to include in the response.

extra_fields

keyword

string

The search term, based on fields:

company_identification.value - The company identification (value) of the branch (exact, case-insensitive).
friendly_name.ar - The friendly name (arabic) of the branch (contains, case-insensitive).
friendly_name.en - The friendly name (english) of the branch (contains, case-insensitive).
name.ar - The name (arabic) of the branch (contains, case-insensitive).
name.en - The name (english) of the branch (contains, case-insensitive).
phone - The phone number of the branch (exact, case-insensitive).

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

ordering

array of strings

The custom ordering of the results. The default ordering is by created_ts descending.

created_ts - The timestamp (ISO 8601) in UTC when the branch was created.
-created_ts - The timestamp (ISO 8601) in UTC when the branch was created. (descending)
modified_ts - The timestamp (ISO 8601) in UTC when the branch was last modified.
-modified_ts - The timestamp (ISO 8601) in UTC when the branch was last modified. (descending)
name - The name of the branch.
-name - The name of the branch. (descending)

ordering

Allowed:

200