{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","name":"Labii API Documentation","description":"## Introduction to Labii API\n\nWelcome to the Labii API! This powerful tool is designed to streamline your workflow and enhance your applications with robust data integration capabilities. Whether you're a developer looking to leverage our features or a business seeking to optimize your processes, the Labii API provides a comprehensive solution tailored to your needs.\n\nThe Labii API is a RESTful API that provides programmatic access to the Labii platform, enabling developers to automate tasks and integrate Labii with other tools. The API supports all standard HTTP methods: GET, POST, PUT, and DELETE, offering flexibility and compatibility with various programming languages and tools.\n\n## Overview\n\nThe Labii API is designed for ease of use and provides extensive documentation on each endpoint. Each endpoint includes information on:\n\n- HTTP Method: The HTTP verb to use (GET, POST, PUT, DELETE).\n    \n- Endpoint URL: The unique path to the resource.\n    \n- Parameters: Required and optional parameters for requests.\n    \n- Responses: Expected response format and data.\n    \n\n## Key Features\n\n- Resource-Based Architecture: Each endpoint in the Labii API represents a specific resource within the Labii platform, such as a project, experiment, or row.\n    \n- Authentication & Authorization: The Labii API uses OAuth 2.0 for secure authentication and authorization, ensuring that only authorized users can access data.\n    \n- Pagination & Filtering: Built-in support for pagination and filtering lets users retrieve specific data subsets based on various criteria, improving data retrieval efficiency.\n    \n\n## Base URL and Endpoint Structure\n\nThe Labii API uses two primary types of URLs for resource access:\n\n**List and Detail Views**\n\n1. List View (for retrieving lists of objects): `{{base_url}}/{app}/{model}/list/{level}/{sid}/{serializer}/`\n    \n2. Detail View (for retrieving details of a single object): `{{base_url}}/{app}/{model}/detail/{sid}/`\n    \n\nThe base_url is typically set to `https://www.labii.dev/` but can be customized for organizations with dedicated Labii servers: `https://[your-subdomain].labii.dev/`\n\n## URL Parameters\n\n• app: The name of the application.  \n• model: The name of the data model (e.g., projects, experiments).  \n• level: Determines the scope of records to retrieve (see the Levels section in the Labii documentation for details).  \n• sid: A static, encrypted identifier for the object. It must align with the specified level (e.g., if level=organization, the sid must match the organization SID).  \n• serializer: Controls the detail level of returned data with three options:  \n• name: Returns only the SID and name of the object (fastest).  \n• list: Returns selected fields (fast).  \n• detail: Returns all fields (slowest).\n\n## API Objects\n\nThe Labii API includes multiple objects representing different entities within the Labii platform. Each object belongs to a specific app and model, with a corresponding set of methods available for interaction.\n\n## Methods\n\nThe Labii API supports the following HTTP methods:\n\n• `GET`: Retrieve one or more objects.  \n• `POST`: Create a new object.  \n• `PUT`: Update an existing object.  \n• `PATCH`: Partially update an existing object.  \n• `DELETE`: Delete an object.\n\n## Permissions\n\nUser access is role-based. Permissions vary based on organizational and project-level roles.\n\n### Organization-Level Roles\n\n• `Admin`: Full access to organization resources.  \n• `Member`: Access as a standard organization member.  \n• `Alumni`: Limited access for former members.  \n• `User`: External users without organizational access.  \n• `Anonymous`: Unauthorized users.\n\n### Project-Level Roles\n\n• `Project Manager`: Full project access.  \n• `Project Edit`: Edit permissions within the project.  \n• `Project View`: View-only access within the project.\n\n## Serializer Options\n\nThe serializer defines the level of detail for returned data, each serving different use cases:\n\n• `name`: Returns only the SID and name.  \n• `list`: Provides basic fields relevant to each table.  \n• `detail`: Returns a comprehensive set of fields, offering the full record structure.\n\nBy providing these serializers, Labii allows developers to optimize data retrieval according to their needs, balancing speed and detail.\n\n## Get Started\n\nTo begin using the Labii API, you'll need to sign up for an account and obtain your API key. The following steps will guide you through the setup process:\n\n1. **Sign Up**: Create an account on the Labii platform.\n    \n2. **Obtain API Key**: After registration, navigate to your dashboard to generate your unique API key.\n    \n3. **Documentation**: Review our detailed API documentation, which covers endpoints, request methods, and response formats.\n    \n4. **Test the API**: Use our sandbox environment to experiment with API calls before going live.\n    \n\n## Reporting Issues\n\nIf you encounter any issues while using the Labii API, we’re here to help! To report a problem, please follow these steps:\n\n1. **Check the Documentation**: Ensure that the issue isn't addressed in our documentation.\n    \n2. **Submit a Support Ticket**: Use our support portal to submit a ticket with detailed information about the issue, including error messages and steps to reproduce the problem.\n    \n3. **Monitor Updates**: Keep an eye on our status page for any ongoing incidents or maintenance updates that may affect API performance.\n    \n\n## Help and Support\n\nWe provide several resources to assist you:\n\n- **API Documentation**: Comprehensive guides and examples to help you integrate and utilize the API effectively.\n    \n- **Community Forum**: Join our community forum to discuss with other users, share tips, and find solutions to common problems.\n    \n- **Support Team**: Reach out to our dedicated support team via email or the contact form on our website for personalized assistance.\n    \n\nWe’re excited to see what you build with the Labii API! If you have any questions or need further assistance, don't hesitate to reach out. Happy coding!","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"38730820","team":6484680,"collectionId":"d3179a29-d7fe-4775-aafb-3e02ca988cd9","publishedId":"2sAY4xB29e","public":true,"publicUrl":"https://api.docs.labii.com","privateUrl":"https://go.postman.co/documentation/38730820-d3179a29-d7fe-4775-aafb-3e02ca988cd9","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01579b"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The Labii API is a RESTful API that provides programmatic access to the Labii platform, enabling developers to automate tasks and integrate Labii with other tools. "},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":"https://content.pstmn.io/bb559b75-a15c-4885-a3c5-d66755472484/MjAwX2NpcmNsZV9saWdodGJsdWVfbGFiaWlfaG9yaXpvbnRhbC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"b3e5fc"}},{"name":"light","logo":"https://content.pstmn.io/69890ef5-8367-4200-8acc-391c17fdf8ee/MjAwX2ZpbGxfbGlnaHRibHVlX2RhcmtibHVlX2hvcml6b250YWwucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01579b"}}]}},"version":"8.10.0","publishDate":"2024-11-03T05:50:08.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"The Labii API is a RESTful API that provides programmatic access to the Labii platform, enabling developers to automate tasks and integrate Labii with other tools. "},"logos":{"logoLight":"https://content.pstmn.io/69890ef5-8367-4200-8acc-391c17fdf8ee/MjAwX2ZpbGxfbGlnaHRibHVlX2RhcmtibHVlX2hvcml6b250YWwucG5n","logoDark":"https://content.pstmn.io/bb559b75-a15c-4885-a3c5-d66755472484/MjAwX2NpcmNsZV9saWdodGJsdWVfbGFiaWlfaG9yaXpvbnRhbC5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/122d2a86aa1cf82f00ac202fe2715924986830f740f7438169813c47555e6c70","favicon":"https://labii.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api.docs.labii.com/view/metadata/2sAY4xB29e"}