API documentation

Request example:

curl "https://kuest.com/api/balance" \
     -H 'Authorization: Bearer ibBWpAL6vJW5ZBDshDRwoDqMluf7PwTc2b5mEvkO'

Response example (HTTP status 200):

{
  "data": {
    "nickname": "mynickname",
    "balance": {
      "currency": "USD",
      "as_worker": "0.10000000",
      "as_creator": "9975.16000000",
      "total": "9,975.26000000"
    }
  }
}

Possible HTTP statuses:

• Successful: 200
• Unauthenticated: 401
• Forbidden: 403
• Too many requests: 429
• Internal error: 500

Request example:

curl "https://kuest.com/api/templates/83" \
     -H 'Authorization: Bearer ibBWpAL6vJW5ZBDshDRwoDqMluf7PwTc2b5mEvkO'

Response example (HTTP status 200):

{
      "id": 83,
      "is_active": true,
      "title": {
        "br": "Backlink no Rodapé",
        "en": "Backlink in Footer"
      },
      "description": {
        "br": "Solicitar inclusão de backlink no rodapé de sites",
        "en": "Request backlink in website footer"
      },
      "min_workers_needed": 20,
      "min_workers_earn": "1.00",
      "steps": [
        {
          "title": {
            "br": "É preciso que você tenha um site ou blog",
            "en": "You must have a website or blog"
          },
          "parameter_placeholder": [],
          "parameter_is_hidden": false,
          "requires_parameter_from_creator": false
        },
        {
          "title": {
            "br": "Crie um link no rodapé do seu site com a palavra-chave",
            "en": "Create a link on your site's footer with the keyword"
          },
          "parameter_placeholder": {
            "br": "Digite aqui a palavra chave",
            "en": "Enter the keyword here"
          },
          "parameter_is_hidden": true,
          "requires_parameter_from_creator": true
        },
        {
          "title": {
            "br": "Apontando para o site:",
            "en": "Linking to the website:"
          },
          "parameter_placeholder": {
            "br": "Digite o link do site aqui",
            "en": "Enter the site URL here"
          },
          "parameter_is_hidden": true,
          "requires_parameter_from_creator": true
        }
      ],
      "proofs": [
        {
          "title": {
            "br": "Qual o link do seu site em que você adicionou o backlink?",
            "en": "What is the link on your site where you added the backlink?"
          },
          "requires_parameter_from_creator": false,
          "type": {
            "id": "Text",
            "title": "Text"
          }
        }
      ],
      "category": {
        "id": 51,
        "title": {
          "br": "Backlink",
          "en": "Backlink"
        },
        "path": "Advertising & SEO \/ Backlink",
        "friendly_title": {
          "br": "Backlink",
          "en": "Backlink"
        }
      }
    }

Possible HTTP statuses:

• Successful: 200
• Unauthenticated: 401
• Forbidden: 403
• Not found: 404
• Too many requests: 429
• Internal error: 500

Request example:

curl "https://kuest.com/api/templates" \
     -H 'Authorization: Bearer ibBWpAL6vJW5ZBDshDRwoDqMluf7PwTc2b5mEvkO'

Response example (HTTP status 200):

{
  "data": [
    {
      "id": 75,
      "is_active": true,
      "title": {
        "br": "Outras",
        "en": "Others"
      },
      "description": {
        "br": "Tarefas customizadas que não se encaixam nas outras categorias",
        "en": "Customized tasks that do not fit into the other categories"
      },
      "min_workers_needed": 20,
      "min_workers_earn": "0.10",
      "steps": [],
      "proofs": [],
      "category": {
        "id": 51,
        "title": {
          "br": "Backlink",
          "en": "Backlink"
        },
        "path": "Advertising & SEO \/ Backlink",
        "friendly_title": {
          "br": "Backlink",
          "en": "Backlink"
        }
      }
    },
    {
      "id": 83,
      "is_active": true,
      "title": {
        "br": "Backlink no Rodapé",
        "en": "Backlink in Footer"
      },
      "description": {
        "br": "Solicitar inclusão de backlink no rodapé de sites",
        "en": "Request backlink in website footer"
      },
      "min_workers_needed": 20,
      "min_workers_earn": "1.00",
      "steps": [
        {
          "title": {
            "br": "\u00c9 preciso que você tenha um site ou blog",
            "en": "You must have a website or blog"
          },
          "parameter_placeholder": [],
          "parameter_is_hidden": false,
          "requires_parameter_from_creator": false
        },
        {
          "title": {
            "br": "Crie um link no rodapé do seu site com a palavra-chave",
            "en": "Create a link on your site's footer with the keyword"
          },
          "parameter_placeholder": {
            "br": "Digite aqui a palavra chave",
            "en": "Enter the keyword here"
          },
          "parameter_is_hidden": true,
          "requires_parameter_from_creator": true
        },
        {
          "title": {
            "br": "Apontando para o site:",
            "en": "Linking to the website:"
          },
          "parameter_placeholder": {
            "br": "Digite o link do site aqui",
            "en": "Enter the site URL here"
          },
          "parameter_is_hidden": true,
          "requires_parameter_from_creator": true
        }
      ],
      "proofs": [
        {
          "title": {
            "br": "Qual o link do seu site em que você adicionou o backlink?",
            "en": "What is the link on your site where you added the backlink?"
          },
          "requires_parameter_from_creator": false,
          "type": {
            "id": "Text",
            "title": "Text"
          }
        }
      ],
      "category": {
        "id": 51,
        "title": {
          "br": "Backlink",
          "en": "Backlink"
        },
        "path": "Advertising & SEO \/ Backlink",
        "friendly_title": {
          "br": "Backlink",
          "en": "Backlink"
        }
      }
    },
    //...
  ],
  "links": {
    "first": "https:\/\/kuest.com\/api\/templates?page=1",
    "last": "https:\/\/kuest.com\/api\/templates?page=4",
    "prev": null,
    "next": "https:\/\/kuest.com\/api\/templates?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "path": "https:\/\/kuest.com\/api\/templates",
    "per_page": 15,
    "to": 15,
    "total": 54
  }
}

Possible HTTP statuses:

• Successful: 200
• Unauthenticated: 401
• Forbidden: 403
• Too many requests: 429
• Internal error: 500

Request example:

curl -X "PATCH" "https://kuest.com/api/owner/tasks/37892062816763904" \
     -H 'Authorization: Bearer ibBWpAL6vJW5ZBDshDRwoDqMluf7PwTc2b5mEvkO' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "days_to_rate": "2",
  "workers_needed": "30",
  "workers_earn": "1.50"
}'

Response example (HTTP status 200):

{
  "data": {
    "id": "37892062816763904",
    "title": {
      "br": "Backlink",
      "en": "Backlink"
    },
    "slug": {
      "br": "backlink",
      "en": "backlink"
    },
    "notes": [],
    "template": {
      "id": 83,
      "title": {
        "br": "Backlink no Rodapé",
        "en": "Backlink in Footer"
      },
      "description": {
        "br": "Solicitar inclus\u00e3o de backlink no rodapé de sites",
        "en": "Request backlink in website footer"
      },
      "category": {
        "id": 51,
        "title": {
          "br": "Backlink",
          "en": "Backlink"
        },
        "path": "Advertising & SEO \/ Backlink",
        "friendly_title": {
          "br": "Backlink",
          "en": "Backlink"
        }
      }
    },
    "workers_needed": 20,
    "workers_earn": "1.00",
    "works_done": 0,
    "progress": "0\/20",
    "progress_percentage": 0,
    "days_to_rate": 7,
    "pause_after_approval": false,
    "workers_not_rated_count": 0,
    "has_reserved_slots": false,
    "created_at": "2022-04-15T13:29:31.776690Z",
    "speed": "Normal",
    "status": "Active",
    "steps": [
      {
        "id": "37892062867095552",
        "title": {
          "br": "É preciso que você tenha um site ou blog",
          "en": "You must have a website or blog"
        },
        "parameter": null
      },
      {
        "id": "37892062900649984",
        "title": {
          "br": "Crie um link no rodapé do seu site com a palavra-chave",
          "en": "Create a link on your site's footer with the keyword"
        },
        "parameter": "example.com"
      },
      {
        "id": "37892062921621504",
        "title": {
          "br": "Apontando para o site:",
          "en": "Linking to the website:"
        },
        "parameter": "example.com"
      }
    ],
    "proofs": [
      {
        "id": "37892063332663296",
        "title": {
          "br": "Qual o link do seu site em que você adicionou o backlink?",
          "en": "What is the link on your site where you added the backlink?"
        },
        "type": "Text"
      }
    ],
    "contracts": []
  }
}

If you don't send any parameters you'll receive the following response with HTTP status 422:

{
  "message": "The given data was invalid.",
  "errors": {
    "message": [
      "No data provided."
    ]
  }
}

If you send invalid parameters you'll receive a detailed response with HTTP status 422:

{
  "message": "The given data was invalid.",
  "errors": {
    "workers_needed": [
      "The workers needed must be at least 31."
    ],
    "workers_earn": [
      "The workers earn must be at least 1.50."
    ]
  }
}

If you don't have enough balance you'll receive the following response with HTTP status 422:

{
  "message": "The given data was invalid.",
  "errors": {
    "message": [
      "You don't have USD 4.7450 to upgrade this kuest. Make a deposit and try again."
    ]
  }
}

Possible HTTP statuses:

• Successful: 200
• Unauthenticated: 401
• Forbidden: 403
• Unprocessable Entity: 422
• Too many requests: 429
• Internal error: 500

Request example:

curl "https://kuest.com/api/owner/tasks" \
-H 'Authorization: Bearer ibBWpAL6vJW5ZBDshDRwoDqMluf7PwTc2b5mEvkO'

Response example (HTTP status 200):

{
    "data": [
    {
      "id": "37892062816763904",
      "title": {
        "br": "Backlink",
        "en": "Backlink"
      },
      "slug": {
        "br": "backlink",
        "en": "backlink"
      },
      "workers_needed": 20,
      "workers_earn": "1.00",
      "works_done": 0,
      "progress": "0\/20",
      "progress_percentage": 0,
      "workers_not_rated_count": 0,
      "status": "Active"
    },
    //...
  ],
  "links": {
    "first": "https:\/\/kuest\.com\/api\/owner\/tasks?page=1",
    "last": "https:\/\/kuest\.com\/api\/owner\/tasks?page=3",
    "prev": null,
    "next": "https:\/\/kuest\.com\/api\/owner\/tasks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "path": "https:\/\/kuest\.com\/api\/owner\/tasks",
    "per_page": 15,
    "to": 15,
    "total": 37
  }
}

Possible HTTP statuses:

• Successful: 200
• Unauthenticated: 401
• Forbidden: 403
• Too many requests: 429
• Internal error: 500

Request example:

curl "https://kuest.com/api/owner/tasks/37892062816763904" \
-H 'Authorization: Bearer ibBWpAL6vJW5ZBDshDRwoDqMluf7PwTc2b5mEvkO'

Response example (HTTP status 200):

{
  "data": {
    "id": "37892062816763904",
    "title": {
      "br": "Backlink",
      "en": "Backlink"
    },
    "slug": {
      "br": "backlink",
      "en": "backlink"
    },
    "notes": [],
    "template": {
      "id": 83,
      "title": {
        "br": "Backlink no Rodapé",
        "en": "Backlink in Footer"
      },
      "description": {
        "br": "Solicitar inclus\u00e3o de backlink no rodapé de sites",
        "en": "Request backlink in website footer"
      },
      "category": {
        "id": 51,
        "title": {
          "br": "Backlink",
          "en": "Backlink"
        },
        "path": "Advertising & SEO \/ Backlink",
        "friendly_title": {
          "br": "Backlink",
          "en": "Backlink"
        }
      }
    },
    "workers_needed": 20,
    "workers_earn": "1.00",
    "works_done": 0,
    "progress": "0\/20",
    "progress_percentage": 0,
    "days_to_rate": 7,
    "pause_after_approval": false,
    "workers_not_rated_count": 0,
    "has_reserved_slots": false,
    "created_at": "2022-04-15T13:29:31.776690Z",
    "speed": "Normal",
    "status": "Active",
    "steps": [
      {
        "id": "37892062867095552",
        "title": {
          "br": "É preciso que você tenha um site ou blog",
          "en": "You must have a website or blog"
        },
        "parameter": null
      },
      {
        "id": "37892062900649984",
        "title": {
          "br": "Crie um link no rodapé do seu site com a palavra-chave",
          "en": "Create a link on your site's footer with the keyword"
        },
        "parameter": "example.com"
      },
      {
        "id": "37892062921621504",
        "title": {
          "br": "Apontando para o site:",
          "en": "Linking to the website:"
        },
        "parameter": "example.com"
      }
    ],
    "proofs": [
      {
        "id": "37892063332663296",
        "title": {
          "br": "Qual o link do seu site em que você adicionou o backlink?",
          "en": "What is the link on your site where you added the backlink?"
        },
        "type": "Text"
      }
    ],
    "contracts": []
  }
}

Possible HTTP statuses:

• Successful: 200
• Unauthenticated: 401
• Forbidden: 403
• Not found: 404
• Too many requests: 429
• Internal error: 500

Request example:

curl "https://kuest.com/api/owner/tasks?ids=32802862975156224,32802862975156223" \
-H 'Authorization: Bearer ibBWpAL6vJW5ZBDshDRwoDqMluf7PwTc2b5mEvkO'

Response example (HTTP status 207):

{
    "data": [
    {
      "id": "32802862975156224",
      "title": {
        "br": "Backlink",
        "en": "Backlink"
      },
      "slug": {
        "br": "backlink",
        "en": "backlink"
      },
      "workers_needed": 20,
      "workers_earn": "1.00",
      "works_done": 0,
      "progress": "0\/20",
      "progress_percentage": 0,
      "workers_not_rated_count": 0,
      "status": "Active"
    },
    {
      "id": "32802862975156223",
      "error": "Kuest not found."
    }
    //...
  ],
  "links": {
    "first": "https:\/\/kuest\.com\/api\/owner\/tasks?page=1",
    "last": "https:\/\/kuest\.com\/api\/owner\/tasks?page=3",
    "prev": null,
    "next": "https:\/\/kuest\.com\/api\/owner\/tasks?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "path": "https:\/\/kuest\.com\/api\/owner\/tasks",
    "per_page": 15,
    "to": 15,
    "total": 37
  }
}

Possible HTTP statuses:

• Successful: 200
• Multi status: 207
• Unauthenticated: 401
• Forbidden: 403
• Not found: 404
• Too many requests: 429
• Internal error: 500