List Tasks
curl --request GET \
--url https://api.contactship.ai/v1/tasks \
--header 'x-api-key: <api-key>'import requests
url = "https://api.contactship.ai/v1/tasks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.contactship.ai/v1/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.contactship.ai/v1/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.contactship.ai/v1/tasks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.contactship.ai/v1/tasks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactship.ai/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"statusCode": 123,
"data": [
{}
],
"pagination.page": 123,
"pagination.total_rows": 123,
"pagination.total_pages": 123
}Tareas
List Tasks
List tasks for the organization identified by the API key.
GET
/
v1
/
tasks
List Tasks
curl --request GET \
--url https://api.contactship.ai/v1/tasks \
--header 'x-api-key: <api-key>'import requests
url = "https://api.contactship.ai/v1/tasks"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.contactship.ai/v1/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.contactship.ai/v1/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.contactship.ai/v1/tasks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.contactship.ai/v1/tasks")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactship.ai/v1/tasks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"statusCode": 123,
"data": [
{}
],
"pagination.page": 123,
"pagination.total_rows": 123,
"pagination.total_pages": 123
}List tasks for the organization identified by the API key.
Keep filters and ordering consistent while advancing offset. This list describes task records; a task’s existence does not prove a message was sent or a call was placed.
Authentication
string
requerido
Organization API key. Keep it on your server or in a credential store.
Query parameters
integer
Page size. Send a positive limit together with offset.
integer
Nonnegative number of records to skip; begin at zero.
string
Field to sort, for example
created_at. Pair with orderDirection.string
ASCENDENT or DESCENDENT.string
URL-encoded JSON array of field/operator/value conditions, for example a status filter using
EQUAL.Example
curl --get 'https://api.contactship.ai/v1/tasks' -H 'x-api-key: YOUR_API_KEY' --data-urlencode 'limit=20' --data-urlencode 'offset=0' --data-urlencode 'orderBy=created_at' --data-urlencode 'orderDirection=DESCENDENT' --data-urlencode 'filters=[{"field":"status","operator":"EQUAL","value":"todo"}]'
Response
number
HTTP status.
number
Current page.
number
Total matching records.
number
Total pages.
