List groups
Gets a paginated list of all user groups in a Canva team.
You can use the startIndex and count parameters to control the pagination of the response.
You can also provide a filter parameter to narrow down the groups returned to only include those matching the filter.
The members array returned in a group's API response is always empty, even if there are members in the group. To see members of a group, you must use the Canva web interface(opens in a new tab or window).
HTTP method and URL path
https://www.canva.com /_scim /v2 /GroupsHeader parameters
Query parameters
startIndexintegerUsed to paginate the response: the index of the first result to return.
countintegerUsed to paginate the response: the number of results to return. Must be between 1 and 10.
filterstringA filter to narrow down the results returned, using the equals (eq) query parameter. The following filters are supported:
-
Return the group matching the SCIM
displayNamevalue:displayName eq "{display_name}".For example:
GET /_scim/v2/Groups?filter=displayName%20eq%20"White rabbits"
Example request
Examples for using the /_scim/v2/Groups endpoint:
curl --request GET 'https://www.canva.com/_scim/v2/Groups' \--header 'Authorization: Bearer {token}'
const fetch = require("node-fetch");fetch("https://www.canva.com/_scim/v2/Groups", {method: "GET",headers: {"Authorization": "Bearer {token}",},}).then(async (response) => {const data = await response.json();console.log(data);}).catch(err => console.error(err));
import java.io.IOException;import java.net.URI;import java.net.http.*;public class ApiExample {public static void main(String[] args) throws IOException, InterruptedException {HttpRequest request = HttpRequest.newBuilder().uri(URI.create("https://www.canva.com/_scim/v2/Groups")).header("Authorization", "Bearer {token}").method("GET", HttpRequest.BodyPublishers.noBody()).build();HttpResponse<String> response = HttpClient.newHttpClient().send(request,HttpResponse.BodyHandlers.ofString());System.out.println(response.body());}}
import requestsheaders = {"Authorization": "Bearer {token}"}response = requests.get("https://www.canva.com/_scim/v2/Groups",headers=headers)print(response.json())
using System.Net.Http;var client = new HttpClient();var request = new HttpRequestMessage{Method = HttpMethod.Get,RequestUri = new Uri("https://www.canva.com/_scim/v2/Groups"),Headers ={{ "Authorization", "Bearer {token}" },},};using (var response = await client.SendAsync(request)){response.EnsureSuccessStatusCode();var body = await response.Content.ReadAsStringAsync();Console.WriteLine(body);};
package mainimport ("fmt""io""net/http")func main() {url := "https://www.canva.com/_scim/v2/Groups"req, _ := http.NewRequest("GET", url, nil)req.Header.Add("Authorization", "Bearer {token}")res, _ := http.DefaultClient.Do(req)defer res.Body.Close()body, _ := io.ReadAll(res.Body)fmt.Println(string(body))}
$curl = curl_init();curl_setopt_array($curl, array(CURLOPT_URL => "https://www.canva.com/_scim/v2/Groups",CURLOPT_CUSTOMREQUEST => "GET",CURLOPT_RETURNTRANSFER => true,CURLOPT_HTTPHEADER => array('Authorization: Bearer {token}',),));$response = curl_exec($curl);$err = curl_error($curl);curl_close($curl);if (empty($err)) {echo $response;} else {echo "Error: " . $err;}
require 'net/http'require 'uri'url = URI('https://www.canva.com/_scim/v2/Groups')http = Net::HTTP.new(url.host, url.port)http.use_ssl = truerequest = Net::HTTP::Get.new(url)request['Authorization'] = 'Bearer {token}'response = http.request(request)puts response.read_body
Success response
If successful, the endpoint returns a 200 response with a JSON body with the following parameters:
schemasstring[]Available values: The only valid value is urn:ietf:params:scim:api:messages:2.0:ListResponse.
totalResultsintegerThe total number of results matching the query.
startIndexintegerThe index of the first result.
itemsPerPageintegerThe number of results returned in the current page.
resourcesScimGroupResponse[]An array of the groups returned in the current page of results.
schemasstring[]Available values: The only valid value is urn:ietf:params:scim:schemas:core:2.0:Group.
idstringThe Canva-generated SCIM ID for the group.
metaobjectMeta properties for the group.
resourceTypestringThe SCIM resource type of the object.
Available values: The only valid value is Group.
createdstringThe timestamp when the object was created.
displayNamestringThe name of the group, suitable for display to end-users.
membersobject[]The members array returned in a group's API response is always empty, even if there are members in the group. To see members of a group, you must use the Canva web interface(opens in a new tab or window).
Example response
{"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults": 1,"startIndex": 1,"itemsPerPage": 10,"resources": [{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],"id": "GAFgrpb1abC","meta": {"resourceType": "Group","created": "2023-09-18T06:08:35Z"},"displayName": "White rabbits","members": []}]}
Error responses
403 Forbidden
schemasstring[]Available values: The only valid value is urn:ietf:params:scim:api:messages:2.0:Error.
detailstringAvailable values: The only valid value is Unsupported filter field.
statusstringThe HTTP status code of the error.
Example error response
{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"detail": "Unsupported filter field","status": "403"}