SSpiderIQ
SSpiderIQ

Docs / api-reference/crm-columns

crm-columns

6 endpoints from the published OpenAPI import.

GET/api/v1/crm/boards/{board_id}/columns

List columns for a board

Parameters

NameInTypeRequiredDescription
board_idpathstringtrue
Try it
Query

Examples

cURL
curl -X GET 'https://spideriq.ai/api/v1/crm/boards/{board_id}/columns' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/crm/boards/{board_id}/columns",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/crm/boards/{board_id}/columns", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/crm/boards/{board_id}/columns", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
POST/api/v1/crm/boards/{board_id}/columns

Create a column

Parameters

NameInTypeRequiredDescription
board_idpathstringtrue
Try it
Query

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/crm/boards/{board_id}/columns' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "slug": "string",
  "position": 0,
  "color": "string",
  "is_done_column": false,
  "mapped_status": "string"
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/crm/boards/{board_id}/columns",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string", "slug": "string", "position": 0, "color": "string", "is_done_column": false, "mapped_status": "string"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/crm/boards/{board_id}/columns", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string", "slug": "string", "position": 0, "color": "string", "is_done_column": false, "mapped_status": "string"})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string", "slug": "string", "position": 0, "color": "string", "is_done_column": false, "mapped_status": "string"}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/crm/boards/{board_id}/columns", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
201Successful Response
422Validation Error
GET/api/v1/crm/columns/{column_id}

Get a column

Parameters

NameInTypeRequiredDescription
column_idpathstringtrue
Try it
Query

Examples

cURL
curl -X GET 'https://spideriq.ai/api/v1/crm/columns/{column_id}' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/crm/columns/{column_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/crm/columns/{column_id}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/crm/columns/{column_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
PATCH/api/v1/crm/columns/{column_id}

Update a column

Parameters

NameInTypeRequiredDescription
column_idpathstringtrue
Try it
Query

Examples

cURL
curl -X PATCH 'https://spideriq.ai/api/v1/crm/columns/{column_id}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "color": "string",
  "wip_limit": 0,
  "is_done_column": true,
  "mapped_status": "string"
}'
Python
import httpx

resp = httpx.patch(
    "https://spideriq.ai/api/v1/crm/columns/{column_id}",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"name": "string", "color": "string", "wip_limit": 0, "is_done_column": true, "mapped_status": "string"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/crm/columns/{column_id}", {
  method: "PATCH",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"name": "string", "color": "string", "wip_limit": 0, "is_done_column": true, "mapped_status": "string"})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"name": "string", "color": "string", "wip_limit": 0, "is_done_column": true, "mapped_status": "string"}`)
	req, _ := http.NewRequest("PATCH", "https://spideriq.ai/api/v1/crm/columns/{column_id}", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error
DELETE/api/v1/crm/columns/{column_id}

Delete a column

Parameters

NameInTypeRequiredDescription
column_idpathstringtrue
Try it
Query

Examples

cURL
curl -X DELETE 'https://spideriq.ai/api/v1/crm/columns/{column_id}' \
  -H 'Authorization: Bearer <token>'
Python
import httpx

resp = httpx.delete(
    "https://spideriq.ai/api/v1/crm/columns/{column_id}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/crm/columns/{column_id}", {
  method: "DELETE",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://spideriq.ai/api/v1/crm/columns/{column_id}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
204Successful Response
422Validation Error
POST/api/v1/crm/boards/{board_id}/columns/reorder

Reorder columns

Parameters

NameInTypeRequiredDescription
board_idpathstringtrue
Try it
Query

Examples

cURL
curl -X POST 'https://spideriq.ai/api/v1/crm/boards/{board_id}/columns/reorder' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "columns": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "position": 0
    }
  ]
}'
Python
import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/crm/boards/{board_id}/columns/reorder",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"columns": [{"id": "00000000-0000-0000-0000-000000000000", "position": 0}]},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://spideriq.ai/api/v1/crm/boards/{board_id}/columns/reorder", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"columns": [{"id": "00000000-0000-0000-0000-000000000000", "position": 0}]})
});
const data = await resp.json();
console.log(data);
Go
package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"columns": [{"id": "00000000-0000-0000-0000-000000000000", "position": 0}]}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/crm/boards/{board_id}/columns/reorder", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

StatusDescription
200Successful Response
422Validation Error