Concepts

Pagination

list or search api use pagination.

Properties to used for pagination:

• maxResults: how many results per response.
• cursor: use the one provided by the previous response to get next page.
• more: the server has more results for you.

# pseudo code
more = True
cursor = None
maxResults= 50
while more:
    resp = api_list_call(maxResults, cursor, {other api parameters} )
    more = resp.more
    cursor = resp.cursor

Common parameters

• customer or customerId: a customer id.
• instance or instanceId: a instance id.
• maxResult: see Pagination.
• cursor: see Pagination.
• more: see Pagination. fields: some api allow to specify which fields should be returned in the response. It may be useful to reduce response size - for big list call.
• callId: used only by the front application, ignore it.
• fields : response will contain only specified properties.

Fields example

users = api_client.get_call("user", "list", fields="items(email, uid)",
print(users)
>>{items: [
>>    {email: "tt@tt.com", uid: "123456789"},
>>    {email: "uu@uu.com", uid: "012345678"},
>>    ...
>>]}

Translation

Most of the text are stored in translatable structure (even if mention as string on the api def)

"title" : {
  "en": "Title",
  "fr": "Titre"
  }