Skip to main content
POST
/
graphql
Send a graphql query or mutation
curl --request POST \
  --url https://functions.prod.jarvi.tech/v1/public-api/graphql \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "operationName": "fields",
  "query": "query fields($limit: Int, $offset: Int, $order_by: [fields_order_by!]!, $where: fields_bool_exp) {\n                    items: fields(\n                      limit: $limit\n                      offset: $offset\n                      order_by: $order_by\n                      where: $where\n                    ) {\n                      id\n                      createdAt\n                      updatedAt\n                      deletedAt\n                      name\n                      userId\n                      type\n                      order\n                      targetedEntity\n                      isHidden\n                      defaultValue\n                      purpose\n                      isMadeForSales\n                      isMadeForRecruitment\n                      values(where: {deletedAt: {_is_null: true}}, order_by: {name: asc}) {\n                        id\n                        fieldId\n                        name\n                        isDefault\n                        technicalValue\n                        __typename\n                      }\n                      parentId\n                      parent {\n                        id\n                        name\n                        isMadeForSales\n                        isMadeForRecruitment\n                        __typename\n                      }\n                      children(where: {deletedAt: {_is_null: true}}, order_by: {order: asc}) {\n                        id\n                        createdAt\n                        updatedAt\n                        deletedAt\n                        name\n                        userId\n                        type\n                        order\n                        targetedEntity\n                        isHidden\n                        defaultValue\n                        purpose\n                        isMadeForSales\n                        isMadeForRecruitment\n                        values(where: {deletedAt: {_is_null: true}}, order_by: {name: asc}) {\n                          id\n                          fieldId\n                          name\n                          isDefault\n                          technicalValue\n                          __typename\n                        }\n                        parentId\n                        parent {\n                          id\n                          name\n                          isMadeForSales\n                          isMadeForRecruitment\n                          __typename\n                        }\n                        __typename\n                      }\n                      __typename\n                    }\n                    total: fields_aggregate(order_by: $order_by, where: $where) {\n                      aggregate {\n                        count\n                        __typename\n                      }\n                      __typename\n                    }\n                  }",
  "variables": {
    "where": {
      "_and": [
        {
          "parentId": {
            "_is_null": true
          }
        },
        {
          "deletedAt": {
            "_is_null": true
          }
        }
      ]
    },
    "limit": 1000,
    "offset": 0,
    "order_by": {
      "order": "asc"
    }
  }
}
'
{
  "data": "The data you wanted to get",
  "errors": "Errors details if any"
}
Cette API peut vous permettre de faire absolument tout ce que vous le souahitez. Vous pouvez personnaliser vos requêtes pour lire / écrire ce dont vous avez besoin.
Nous ne garantissons pas que les informations disponibles dans cette API ne changent pas sans préavis. Nous vous conseillons de ne utiliser cette API pour des utilisations critiques sans nous en parler préalablement.

Ouvrir l'éditeur de requêtes

L’éditeur vous permet d’avoir une interface détaillant toutes les possibilités et vous permettant de tester vos requêtes en direct.
Voici comment utiliser l’éditeur de requête en vidéo :

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
operationName
string

The name of the operation. Used for log and debugging. If not provided, will be the first word of the query or mutation

Example:

"fields"

​
query
string

The graphQL query as a SourcesEnum. You can use the playground console to build and test your requests and see all the possibilies

Example:

"query fields($limit: Int, $offset: Int, $order_by: [fields_order_by!]!, $where: fields_bool_exp) {\n items: fields(\n limit: $limit\n offset: $offset\n order_by: $order_by\n where: $where\n ) {\n id\n createdAt\n updatedAt\n deletedAt\n name\n userId\n type\n order\n targetedEntity\n isHidden\n defaultValue\n purpose\n isMadeForSales\n isMadeForRecruitment\n values(where: {deletedAt: {_is_null: true}}, order_by: {name: asc}) {\n id\n fieldId\n name\n isDefault\n technicalValue\n __typename\n }\n parentId\n parent {\n id\n name\n isMadeForSales\n isMadeForRecruitment\n __typename\n }\n children(where: {deletedAt: {_is_null: true}}, order_by: {order: asc}) {\n id\n createdAt\n updatedAt\n deletedAt\n name\n userId\n type\n order\n targetedEntity\n isHidden\n defaultValue\n purpose\n isMadeForSales\n isMadeForRecruitment\n values(where: {deletedAt: {_is_null: true}}, order_by: {name: asc}) {\n id\n fieldId\n name\n isDefault\n technicalValue\n __typename\n }\n parentId\n parent {\n id\n name\n isMadeForSales\n isMadeForRecruitment\n __typename\n }\n __typename\n }\n __typename\n }\n total: fields_aggregate(order_by: $order_by, where: $where) {\n aggregate {\n count\n __typename\n }\n __typename\n }\n }"

​
variables
object

If you have variables in your query or mutation, you can provide them here. You can use the playground console to build and test your requests and see all the possibilies

Example:
{
  "where": {
    "_and": [
      { "parentId": { "_is_null": true } },
      { "deletedAt": { "_is_null": true } }
    ]
  },
  "limit": 1000,
  "offset": 0,
  "order_by": { "order": "asc" }
}

Response

GraphQL response (can contain errors)

​
data
object
Example:

"The data you wanted to get"

​
errors
object
Example:

"Errors details if any"