--- title: List projects slug: project-api/list-projects docTags: createdAt: 2024-06-10T16:48:55.566Z --- { "id": "z5H2lbz-GpBxXhuJp3qly", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.catenda.com/v2/projects", "servers": [ { "url": "https://api.catenda.com/v2/projects" } ], "name": "List projects", "description": "List all projects the current user is a member of.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "All data in Catenda belongs to a project and has a single owner.\n", "customType": "project[]", "schema": [ { "name": "createdAt", "kind": "optional", "type": "string", "description": "The date and time the project was created in ISO 8601 format", "example": "2016-09-26T14:45:05.000Z" }, { "name": "description", "kind": "optional", "type": "string", "description": "A short text describing the project, limited to 1024 characters", "example": "Project description" }, { "name": "id", "kind": "optional", "type": "string", "description": "A unique identifier for the project, represented as compacted UUID using 32 hexadecimal characters", "example": "af2d8af0fa54465b89bf26dd3d92cfd0" }, { "name": "imageUrl", "kind": "optional", "type": "string", "description": "The URL for the project cover picture", "example": "https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/image" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the project, limited to 512 characters", "example": "Project name" }, { "name": "owner", "kind": "optional", "type": "object", "description": "Represents a User, Organization or Team.\n\nA User is someone with a Catenda account, commonly representing a person.\n\nAn Organization represents a company, project organization or an application. Organizations do not have a username and cannot sign in to Catenda.\n\nA Team represents a group of users within a project. Teams do not have a username and cannot sign in to Catenda.\n", "modelRef": "#/components/schemas/user", "customType": "user", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Represented as compacted UUID using 32 hexadecimal characters", "example": "524809076a694255b989d236517a55da" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the user, limited to 128 characters", "example": "John Doe" }, { "name": "username", "kind": "optional", "type": "string", "description": "The handle the user identifies with. \n\nCommonly the username will be in email address format. Usernames are unique but subject to change, we recommend using the id field to reference users instead.\n\nIf the user represents an organization or a team the value is always null.\n\nLimited to 50 characters.\n", "example": "john@doe.com" }, { "name": "email", "kind": "optional", "type": "string", "description": "Email address of the User", "example": "john@doe.com" }, { "name": "createdAt", "kind": "optional", "type": "string", "description": "The date and time the user was created in ISO 8601 format", "example": "2016-09-20T14:55:22.000Z" }, { "name": "avatarUrl", "kind": "optional", "type": "string", "description": "The URL for the user avatar", "example": "https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512" }, { "name": "type", "kind": "optional", "type": "string", "description": "The type of user, valid values are:\n - user\n - organization\n - team\n", "example": "user" } ] }, { "name": "siteLocation", "kind": "optional", "type": "object", "description": "The approximate location (latitude, longitude in WGS 84) of the project", "modelRef": "#/components/schemas/latitude-longitude", "customType": "latitude-longitude", "schema": [ { "name": "latitude", "kind": "required", "type": "number", "description": "Latitude, in degrees", "example": 59.913600296798755 }, { "name": "longitude", "kind": "required", "type": "number", "description": "Longitude, in degrees", "example": 10.644988059866593 } ] }, { "name": "updatedAt", "kind": "optional", "type": "string", "description": "The date and time of the last change to the project in ISO 8601 format", "example": "2016-09-26T14:45:40.000Z" } ], "modelRef": "#/components/schemas/project", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "ijSqymwKKhF6MPb9AyiS7", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.catenda.com/v2/projects \\\n --header 'accept: application/json'" }, { "id": "rkG_0m__JopDtIPqEbsLK", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/v2/projects\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "CV-Y7-ZTZz5KdpdojE_me", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/v2/projects\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "wL3vkvOdKr1h-yXO5AVcr", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/v2/projects\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ijSqymwKKhF6MPb9AyiS7" }, "results": { "languages": [ { "id": "oHGB7QypoBojvR3N3u-g8", "language": "200", "code": "// OK\n[\n {\n \"createdAt\": \"2016-09-26T14:45:05.000Z\",\n \"description\": \"Project description\",\n \"id\": \"af2d8af0fa54465b89bf26dd3d92cfd0\",\n \"imageUrl\": \"https://api.catenda.com/v2/projects/67551168422040148d8ae198a321494d/image\",\n \"name\": \"Project name\",\n \"owner\": {\n \"id\": \"524809076a694255b989d236517a55da\",\n \"name\": \"John Doe\",\n \"username\": \"john@doe.com\",\n \"email\": \"john@doe.com\",\n \"createdAt\": \"2016-09-20T14:55:22.000Z\",\n \"avatarUrl\": \"https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512\",\n \"type\": \"user\"\n },\n \"siteLocation\": {\n \"latitude\": 59.913600296798755,\n \"longitude\": 10.644988059866593\n },\n \"updatedAt\": \"2016-09-26T14:45:40.000Z\"\n }\n]" } ], "selectedLanguageId": "oHGB7QypoBojvR3N3u-g8" } }, "children": [ { "text": "" } ] }