List edit proposals

:::openapi-operation GET /api/v1/workspaces/{workspace}/proposals AUTH bearerAuth :::

:::codesamples open Code examples

curl -X GET "https://contextowl.co/api/v1/workspaces/string/proposals?status=pending" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token>"

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
  public static void main(String[] args) throws Exception {
    var client = HttpClient.newHttpClient();
    var request = HttpRequest.newBuilder()
        .uri(URI.create("https://contextowl.co/api/v1/workspaces/string/proposals?status=pending"))
        .header("Accept", "application/json")
        .header("Authorization", "Bearer <token>")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();

    var response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode());
    System.out.println(response.body());
  }
}

import urllib.request

url = "https://contextowl.co/api/v1/workspaces/string/proposals?status=pending"
headers = {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
}
data = None
req = urllib.request.Request(url, data=data, headers=headers, method="GET")
with urllib.request.urlopen(req) as res:
    print(res.status)
    print(res.read().decode())

const response = await fetch("https://contextowl.co/api/v1/workspaces/string/proposals?status=pending", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer <token>",
  }
});

console.log(response.status);
console.log(await response.json());

package main

import (
	"fmt"
	"io"
	"net/http"
	"time"
)

func main() {
	req, err := http.NewRequest("GET", "https://contextowl.co/api/v1/workspaces/string/proposals?status=pending", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Authorization", "Bearer <token>")
	client := &http.Client{Timeout: 30 * time.Second}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	bodyBytes, err := io.ReadAll(io.LimitReader(res.Body, 10<<20))
	if err != nil {
		panic(err)
	}
	fmt.Println(res.StatusCode)
	fmt.Println(string(bodyBytes))
}

// cargo add reqwest --features blocking
fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::blocking::Client::new();
    let response = client.request(reqwest::Method::GET, "https://contextowl.co/api/v1/workspaces/string/proposals?status=pending")
        .header("Accept", "application/json")
        .header("Authorization", "Bearer <token>")
        .send()?;

    println!("{}", response.status());
    println!("{}", response.text()?);
    Ok(())
}

:::

:::details open Parameters (2)

NAME	IN	TYPE	REQUIRED	DESCRIPTION
`workspace`	path	string	yes	Workspace id, or - for the key's bound workspace
`status`	query	string enum: pending, approved, rejected, all	no	pending (default), approved, rejected, or all

:::

:::details open Success responses (200)

200

Success

Content-Type: application/json

FIELD	TYPE	REQUIRED	DESCRIPTION
`[]author`	string	yes	-
`[]authorId`	integer	no	-
`[]createdAt`	string (date-time)	yes	-
`[]createdLabel`	string	yes	-
`[]id`	integer	yes	-
`[]note`	string	yes	-
`[]objectType`	string	yes	-
`[]payload`	string (byte)	yes	-
`[]reviewNote`	string	yes	-
`[]reviewedAt`	string (date-time)	no	-
`[]reviewedBy`	integer	no	-
`[]reviewer`	string	yes	-
`[]status`	string	yes	-
`[]via`	string	yes	-
`[]workspaceId`	string	yes	-

[
  {
    "author": "string",
    "authorId": 0,
    "createdAt": "string",
    "createdLabel": "string",
    "id": 0,
    "note": "string",
    "objectType": "string",
    "payload": "string",
    "reviewNote": "string",
    "reviewedAt": "string",
    "reviewedBy": 0,
    "reviewer": "string",
    "status": "string",
    "via": "string",
    "workspaceId": "string"
  }
]

:::

:::details Error responses (400, 401, 403, 404, 429)

400

Bad request

Content-Type: application/json

FIELD	TYPE	REQUIRED	DESCRIPTION
`error`	object	yes	-

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

401

Unauthorized

Content-Type: application/json

FIELD	TYPE	REQUIRED	DESCRIPTION
`error`	object	yes	-

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

403

Forbidden

Content-Type: application/json

FIELD	TYPE	REQUIRED	DESCRIPTION
`error`	object	yes	-

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

404

Not found

Content-Type: application/json

FIELD	TYPE	REQUIRED	DESCRIPTION
`error`	object	yes	-

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

429

Rate limited

Content-Type: application/json

FIELD	TYPE	REQUIRED	DESCRIPTION
`error`	object	yes	-

{
  "error": {
    "code": "string",
    "details": null,
    "message": "string",
    "status": 0
  }
}

:::