API Reference

Builds

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve build

$client->builds->retrieve(string buildID): Build

GET/v0/builds/{buildId}

Retrieve a build by its ID.

ParametersExpand Collapse

buildID: string

Build ID

ReturnsExpand Collapse

Build

string id

Build ID

string configCommit

\Datetime createdAt

?DocumentedSpec documentedSpec

Object_ object

string org

string project

Targets targets

\Datetime updatedAt

Retrieve build

PHP

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'staging');

$build = $client->builds->retrieve('buildId');

var_dump($build);

200 example

{
  "id": "id",
  "config_commit": "config_commit",
  "created_at": "2019-12-27T18:11:19.117Z",
  "documented_spec": {
    "content": "content",
    "type": "content"
  },
  "object": "build",
  "org": "org",
  "project": "project",
  "targets": {
    "cli": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "csharp": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "go": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "java": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "kotlin": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "node": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "openapi": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "php": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "python": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "ruby": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "sql": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "terraform": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "typescript": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    }
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "id",
  "config_commit": "config_commit",
  "created_at": "2019-12-27T18:11:19.117Z",
  "documented_spec": {
    "content": "content",
    "type": "content"
  },
  "object": "build",
  "org": "org",
  "project": "project",
  "targets": {
    "cli": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "csharp": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "go": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "java": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "kotlin": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "node": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "openapi": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "php": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "python": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "ruby": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "sql": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "terraform": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    },
    "typescript": {
      "commit": {
        "status": "not_started"
      },
      "install_url": "install_url",
      "object": "build_target",
      "status": "not_started",
      "build": {
        "status": "not_started"
      },
      "lint": {
        "status": "not_started"
      },
      "test": {
        "status": "not_started"
      }
    }
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}