Create a board

POST

/v1/boards

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.focal.inc/v1/boards");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Idempotency-Key: looker-sync-2027-03-04-0001");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"space_id\": \"6916bc3d-e1ab-425b-ac25-eefada01a9a2\", \"name\": \"Spring 2027 Campaign\", \"description\": \"Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.\" }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.focal.inc/v1/boards"),
    Headers =
    {
        { "Idempotency-Key", "looker-sync-2027-03-04-0001" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"space_id\": \"6916bc3d-e1ab-425b-ac25-eefada01a9a2\", \"name\": \"Spring 2027 Campaign\", \"description\": \"Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://api.focal.inc/v1/boards"

  payload := strings.NewReader("{ \"space_id\": \"6916bc3d-e1ab-425b-ac25-eefada01a9a2\", \"name\": \"Spring 2027 Campaign\", \"description\": \"Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.\" }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Idempotency-Key", "looker-sync-2027-03-04-0001")
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.focal.inc/v1/boards"))
    .header("Idempotency-Key", "looker-sync-2027-03-04-0001")
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"space_id\": \"6916bc3d-e1ab-425b-ac25-eefada01a9a2\", \"name\": \"Spring 2027 Campaign\", \"description\": \"Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.\" }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"space_id\": \"6916bc3d-e1ab-425b-ac25-eefada01a9a2\", \"name\": \"Spring 2027 Campaign\", \"description\": \"Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.\" }");
Request request = new Request.Builder()
  .url("https://api.focal.inc/v1/boards")
  .post(body)
  .addHeader("Idempotency-Key", "looker-sync-2027-03-04-0001")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://api.focal.inc/v1/boards',
  headers: {
    'Idempotency-Key': 'looker-sync-2027-03-04-0001',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  data: {
    space_id: '6916bc3d-e1ab-425b-ac25-eefada01a9a2',
    name: 'Spring 2027 Campaign',
    description: 'Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.'
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.focal.inc/v1/boards';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'looker-sync-2027-03-04-0001',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"space_id":"6916bc3d-e1ab-425b-ac25-eefada01a9a2","name":"Spring 2027 Campaign","description":"Deliverables, owners and launch dates for the spring 2027 outdoor apparel push."}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"space_id\": \"6916bc3d-e1ab-425b-ac25-eefada01a9a2\", \"name\": \"Spring 2027 Campaign\", \"description\": \"Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.\" }")
val request = Request.Builder()
  .url("https://api.focal.inc/v1/boards")
  .post(body)
  .addHeader("Idempotency-Key", "looker-sync-2027-03-04-0001")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.focal.inc/v1/boards";

    let payload = json!({
        "space_id": "6916bc3d-e1ab-425b-ac25-eefada01a9a2",
        "name": "Spring 2027 Campaign",
        "description": "Deliverables, owners and launch dates for the spring 2027 outdoor apparel push."
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Idempotency-Key", "looker-sync-2027-03-04-0001".parse().unwrap());
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url https://api.focal.inc/v1/boards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: looker-sync-2027-03-04-0001' \
  --data '{ "space_id": "6916bc3d-e1ab-425b-ac25-eefada01a9a2", "name": "Spring 2027 Campaign", "description": "Deliverables, owners and launch dates for the spring 2027 outdoor apparel push." }'

wget --quiet \
  --method POST \
  --header 'Idempotency-Key: looker-sync-2027-03-04-0001' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "space_id": "6916bc3d-e1ab-425b-ac25-eefada01a9a2", "name": "Spring 2027 Campaign", "description": "Deliverables, owners and launch dates for the spring 2027 outdoor apparel push." }' \
  --output-document \
  - https://api.focal.inc/v1/boards

Create a board in a space. The new board comes with the same starting columns and single grid view (All Tasks) a board created from the Focal web app gets — Name, Status, Start Date, Due Date, New assets, Brief, Created by, Updated by, Updated at — and no rows. Read the created columns back with GET /v1/boards/{id}/columns, then add rows with POST /v1/boards/{id}/rows.

Returns 403 when the caller may not create boards in the space, and 404 when the space isn’t visible to the token.

Required scope: boards:write. Rate-limit cost: 10. An Idempotency-Key header is required.

Authorizations

bearerAuth

Parameters

Header Parameters

Idempotency-Key

required

string

<= 255 characters

Example

looker-sync-2027-03-04-0001

Client-generated key (≤255 chars) for safe retries. A retry with the same key replays the original response instead of re-applying the write; reusing a key with a different body → 400, an in-flight key → 409. Required on POST; optional on PATCH/DELETE. A UUID v4 is recommended — generate one per logical write and reuse it only for retries of that write.

Request Body^required

application/json

object

space_id

required

The space to create the board in.

string format: uuid

Example

6916bc3d-e1ab-425b-ac25-eefada01a9a2

name

required

Display name of the board. 1–255 characters.

string

>= 1 characters <= 255 characters

Example

Spring 2027 Campaign

description

Free-form description of the board (≤2000 characters). Pass null to clear it.

string

nullable <= 2000 characters

Example

Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.

Responses

201

Created

application/json

object

data

required

object

required

string format: uuid

name

required

string

description

required

Free-form description set by the board’s author. null when the author hasn’t written one.

string

nullable

organization_id

required

string format: uuid

space_id

required

string format: uuid

created_at

required

string format: date-time

updated_at

required

string format: date-time

html_url

required

Browser URL that opens this board in the Focal web app. Hand this to users as a clickable link.

string

Example

{
  "data": {
    "id": "24ce3d43-516c-4375-9d51-e9a2c8333683",
    "name": "Spring 2027 Campaign",
    "description": "Deliverables, owners and launch dates for the spring 2027 outdoor apparel push.",
    "organization_id": "b46d9033-24b2-4441-87ad-2151088fde01",
    "space_id": "6916bc3d-e1ab-425b-ac25-eefada01a9a2",
    "created_at": "2027-03-04T10:15:00Z",
    "updated_at": "2027-03-06T14:42:00Z",
    "html_url": "https://app.focal.inc/spaces/6916bc3d-e1ab-425b-ac25-eefada01a9a2/boards/24ce3d43-516c-4375-9d51-e9a2c8333683"
  }
}

400

The request was malformed (invalid cursor, unknown type, validation failure, etc.). error.code is bad_request.

application/json

Canonical error envelope. code is stable across releases and intended for programmatic handling; message is human-readable. details only appears for validation failures and lists the offending fields.

object

error

required

object

code

required

string

Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error

message

required

string

details

Array<object>

object

field

string

issue

required

string

Example

{
  "error": {
    "code": "bad_request",
    "message": "Invalid request body",
    "details": [
      {
        "field": "space_id",
        "issue": "Invalid UUID"
      }
    ]
  }
}

401

Missing, invalid, or disabled token. error.code is unauthenticated.

application/json

object

error

required

object

code

required

string

Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error

message

required

string

details

Array<object>

object

field

string

issue

required

string

Example

{
  "error": {
    "code": "unauthenticated",
    "message": "Bearer token is missing or invalid"
  }
}

403

The token doesn’t have the scope this endpoint requires. error.code is forbidden.

application/json

object

error

required

object

code

required

string

Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error

message

required

string

details

Array<object>

object

field

string

issue

required

string

Example

{
  "error": {
    "code": "forbidden",
    "message": "Token doesn't have the required scope"
  }
}

404

Resource doesn’t exist or is outside the token’s space allow-list. The two cases share a response shape so a restricted token can’t probe for the existence of out-of-scope spaces. error.code is not_found.

application/json

object

error

required

object

code

required

string

Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error

message

required

string

details

Array<object>

object

field

string

issue

required

string

Example

{
  "error": {
    "code": "not_found",
    "message": "Not found"
  }
}

409

The request conflicts with the current state. Most commonly a concurrent request carrying the same Idempotency-Key is still in flight. error.code is conflict.

application/json

object

error

required

object

code

required

string

Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error

message

required

string

details

Array<object>

object

field

string

issue

required

string

Example

{
  "error": {
    "code": "conflict",
    "message": "A request with this Idempotency-Key is already being processed"
  }
}

429

Rate limit exceeded. error.code is rate_limited. Wait the number of seconds in the Retry-After header before retrying. Quotas are per-token; see the “Rate limiting” section at the top of this document.

application/json

object

error

required

object

code

required

string

Allowed values: unauthenticated forbidden not_found bad_request conflict rate_limited internal_error

message

required

string

details

Array<object>

object

field

string

issue

required

string

Example

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit of 1000 units per 60s exceeded (this request cost 5)"
  }
}

Headers

Retry-After

integer

Example

Seconds to wait before retrying.

Create a board

Authorizations

Parameters

Header Parameters

Example

Request Bodyrequired

Example

Example

Example

Responses

201

Example

400

Example

401

Example

403

Example

404

Example

409

Example

429

Example

Headers

Example

Request Body^required