> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.cloudraker.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server. # Get a project by number key GET /api/projects/by-number/{numberKey} Returns a single project by its `PREFIX-N` number key. 404 when missing or inaccessible. Reference: https://docs.cloudraker.com/api/raker-one-api/projects/get-projects-by-number-by-number-key ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: RakerOne API version: 1.0.0 paths: /projects/by-number/{numberKey}: get: operationId: get-projects-by-number-by-number-key summary: Get a project by number key description: >- Returns a single project by its `PREFIX-N` number key. 404 when missing or inaccessible. tags: - subpackage_projects parameters: - name: numberKey in: path description: The project's `PREFIX-N` number key (e.g. `IMM-42`). required: true schema: type: string - name: Authorization in: header description: >- WorkOS session JWT or an organization API key, sent as `Authorization: Bearer `. required: true schema: type: string responses: '200': description: The project. content: application/json: schema: $ref: '#/components/schemas/ProjectResponse' '401': description: Unauthorized — missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' servers: - url: /api description: Current origin - url: https://app.raker.one/api description: Production components: schemas: Section: type: object properties: id: type: string kind: type: string title: type: string config: type: object additionalProperties: description: Any type required: - id - kind - title - config title: Section AccessList: type: object properties: roles: type: array items: type: string userIds: type: array items: type: string required: - roles - userIds title: AccessList ProjectStatus: type: string enum: - active - closed title: ProjectStatus ProjectStorageBackendKind: type: string enum: - managed - sharepoint - drive title: ProjectStorageBackendKind ProjectStorageBackend: type: object properties: kind: $ref: '#/components/schemas/ProjectStorageBackendKind' credentialId: type: - string - 'null' rootDirectoryId: type: - string - 'null' required: - kind title: ProjectStorageBackend Project: type: object properties: _id: type: string number: type: number format: double prefix: type: string numberKey: type: string name: type: string description: type: string icon: type: string templateId: type: - string - 'null' sections: type: array items: $ref: '#/components/schemas/Section' access: $ref: '#/components/schemas/AccessList' status: $ref: '#/components/schemas/ProjectStatus' closedAt: type: - string - 'null' storageBackend: $ref: '#/components/schemas/ProjectStorageBackend' createdAt: type: string updatedAt: type: string createdBy: type: string createdByAttribution: type: - string - 'null' provisionAttempt: type: - string - 'null' required: - _id - number - prefix - numberKey - name - description - icon - templateId - sections - access - status - closedAt - createdAt - updatedAt - createdBy - createdByAttribution - provisionAttempt title: Project ProjectResponse: type: object properties: project: $ref: '#/components/schemas/Project' required: - project title: ProjectResponse ErrorResponse: type: object properties: error: type: string description: Machine-readable error code (e.g. `invalid_body`, `not_found`). issues: type: array items: description: Any type description: Schema-validation issues, present when `error` is `invalid_body`. required: - error description: Standard API error response. title: ErrorResponse securitySchemes: bearerAuth: type: http scheme: bearer description: >- WorkOS session JWT or an organization API key, sent as `Authorization: Bearer `. ``` ## Examples **Request** ```json {} ``` **Response** ```json { "project": { "_id": "64b8f9a2e4b0c123456789ab", "number": 42, "prefix": "IMM", "numberKey": "IMM-42", "name": "Immersive Media Project", "description": "A project focused on developing immersive media experiences using VR and AR technologies.", "icon": "🎥", "templateId": "tmpl_9876543210abcdef", "sections": [ { "id": "sec_001", "kind": "overview", "title": "Project Overview", "config": { "summary": "This section provides a high-level summary of the project goals and milestones." } } ], "access": { "roles": [ "admin", "editor", "viewer" ], "userIds": [ "user_12345", "user_67890" ] }, "status": "active", "closedAt": null, "createdAt": "2024-04-10T09:15:00Z", "updatedAt": "2024-06-01T16:45:00Z", "createdBy": "user_12345", "createdByAttribution": "Jane Doe", "provisionAttempt": null, "storageBackend": { "kind": "managed", "credentialId": "cred_abc123def456", "rootDirectoryId": "dir_789xyz" } } } ``` **SDK Code** ```python import requests url = "https://api/projects/by-number/numberKey" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api/projects/by-number/numberKey'; const options = { method: 'GET', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api/projects/by-number/numberKey" payload := strings.NewReader("{}") req, _ := http.NewRequest("GET", url, payload) req.Header.Add("Authorization", "Bearer ") 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)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api/projects/by-number/numberKey") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api/projects/by-number/numberKey") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('GET', 'https://api/projects/by-number/numberKey', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api/projects/by-number/numberKey"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api/projects/by-number/numberKey")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```