Tailor Platform GraphQL API Specification

The Tailor Platform GraphQL API offers flexibility and the ability to define precisely the data you want to fetch.

Endpoint

The application name, combined with eight randomly generated characters, will be used to form the production API endpoint URL for your application. For example, if your application name is test, the domain name for your application will be in the format:

https://test-abcdefgh.erp.dev

You can execute GraphQL queries by sending POST HTTP requests to https://test-abcdefgh.erp.dev/query and access GraphQL Playground at https://test-abcdefgh.erp.dev/playground.

Get started with GraphQL API

Please see GraphQL basics to get started with GraphQL API.

Authentication

To access resources log in to your application.

Pagination, Filtering, and Sorting

You can paginate, filter, and sort data through GraphQL query inputs.

from and size arguments are used for pagination.
order argument is used for sorting.
query argument is used for filtering.

<span><span style="color: var(--shiki-token-function)">QueryNames</span><span style="color: var(--shiki-color-text)">(</span></span>
<span><span style="color: var(--shiki-color-text)">  from: </span><span style="color: var(--shiki-token-constant)">Int</span></span>
<span><span style="color: var(--shiki-color-text)">  size: </span><span style="color: var(--shiki-token-constant)">Int</span></span>
<span><span style="color: var(--shiki-color-text)">  order: [</span><span style="color: var(--shiki-token-constant)">QueryNameOrderInput</span><span style="color: var(--shiki-color-text)">]</span></span>
<span><span style="color: var(--shiki-color-text)">  query: </span><span style="color: var(--shiki-token-constant)">QueryNameQueryInput</span></span>
<span><span style="color: var(--shiki-color-text)">)</span></span>
<span></span>

Pagination

You can do pagination of the query by defining from and size in query inputs. You will get the size number of data from from position of the data.

Here is the example of query and response data.

<span><span style="color: var(--shiki-token-keyword)">query</span><span style="color: var(--shiki-color-text)"> {</span></span>
<span><span style="color: var(--shiki-color-text)">  users(from: </span><span style="color: var(--shiki-token-constant)">3</span><span style="color: var(--shiki-color-text)">, size: </span><span style="color: var(--shiki-token-constant)">2</span><span style="color: var(--shiki-color-text)">) {</span></span>
<span><span style="color: var(--shiki-color-text)">    collection {</span></span>
<span><span style="color: var(--shiki-color-text)">      id</span></span>
<span><span style="color: var(--shiki-color-text)">    }</span></span>
<span><span style="color: var(--shiki-color-text)">  }</span></span>
<span><span style="color: var(--shiki-color-text)">}</span></span>
<span></span>

The above query respond 4th and 5th data.

<span><span style="color: var(--shiki-color-text)">{</span></span>
<span><span style="color: var(--shiki-color-text)">  </span><span style="color: var(--shiki-token-keyword)">&quot;data&quot;</span><span style="color: var(--shiki-token-punctuation)">:</span><span style="color: var(--shiki-color-text)"> {</span></span>
<span><span style="color: var(--shiki-color-text)">    </span><span style="color: var(--shiki-token-keyword)">&quot;users&quot;</span><span style="color: var(--shiki-token-punctuation)">:</span><span style="color: var(--shiki-color-text)"> {</span></span>
<span><span style="color: var(--shiki-color-text)">      </span><span style="color: var(--shiki-token-keyword)">&quot;collection&quot;</span><span style="color: var(--shiki-token-punctuation)">:</span><span style="color: var(--shiki-color-text)"> [</span></span>
<span><span style="color: var(--shiki-color-text)">        {</span></span>
<span><span style="color: var(--shiki-color-text)">          </span><span style="color: var(--shiki-token-keyword)">&quot;id&quot;</span><span style="color: var(--shiki-token-punctuation)">:</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">&quot;bb2b565d-e2ce-4604-865d-7b7386ff38e0&quot;</span></span>
<span><span style="color: var(--shiki-color-text)">        }</span></span>
<span><span style="color: var(--shiki-color-text)">        {</span></span>
<span><span style="color: var(--shiki-color-text)">          </span><span style="color: var(--shiki-token-keyword)">&quot;id&quot;</span><span style="color: var(--shiki-token-punctuation)">:</span><span style="color: var(--shiki-color-text)"> </span><span style="color: var(--shiki-token-string-expression)">&quot;1b22c830-aec6-4195-bb8c-8a670d836e23&quot;</span></span>
<span><span style="color: var(--shiki-color-text)">        }</span></span>
<span><span style="color: var(--shiki-color-text)">      ]</span></span>
<span><span style="color: var(--shiki-color-text)">    }</span></span>
<span><span style="color: var(--shiki-color-text)">  }</span></span>
<span><span style="color: var(--shiki-color-text)">}</span></span>
<span></span>

Sorting

You can use the order: [QueryNameOrderInput] argument to sort the results of the query. The argument accepts an array of QueryNameOrderInput values, each of which will be evaluated in the order specified in the array.

Argument	Description
direction	Desc or Asc
field	Field name as the enumeration value

Filtering

Refer to Filters guide.

Service specific API specification

The API reference is based on the current Tailor Platform GraphQL schema.

Tailor DB API: provides primary database within Tailor Platform, where you store and retrieve your data.
StateFlow API: provides state management capabilities.