Get Collection

curl --request GET \
  --url https://{instance}.domo.com/api/datastores/v1/collections/{collectionId} \
  --header 'X-DOMO-Developer-Token: <api-key>'

import requests

url = "https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}"

headers = {"X-DOMO-Developer-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-DOMO-Developer-Token': '<api-key>'}};

fetch('https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "232e6d6c-46e9-49b6-a137-8933f0f05999",
  "datastoreId": "39b88a97-8247-4c0d-ba1d-8ed78d1a6680",
  "defaultPermissions": null,
  "requiredAuthorities": null,
  "owner": 870010733,
  "name": "users",
  "datasourceId": null,
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "username"
      },
      {
        "type": "STRING",
        "name": "email"
      }
    ]
  },
  "filters": null,
  "syncEnabled": true,
  "syncRequired": false,
  "fullReplaceRequired": false,
  "lastSync": null,
  "createdOn": "2024-01-15T18:42:30.115Z",
  "updatedOn": "2024-01-15T18:42:30.115Z",
  "updatedBy": 870010733
}

{
  "message": "Cannot find permission from source [USER:870010733] to target [MAGNUM_COLLECTION:a3f7d891-bc24-4e56-9a12-c7e3b0f845d2]. Permission Service reports that one or both does not exist",
  "status": 404,
  "statusReason": "Not Found",
  "toe": "RG3808D5LS-DHKE4-TG5EB"
}

GET

api

datastores

collections

{collectionId}

Get Collection

curl --request GET \
  --url https://{instance}.domo.com/api/datastores/v1/collections/{collectionId} \
  --header 'X-DOMO-Developer-Token: <api-key>'

import requests

url = "https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}"

headers = {"X-DOMO-Developer-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-DOMO-Developer-Token': '<api-key>'}};

fetch('https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-DOMO-Developer-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/datastores/v1/collections/{collectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "232e6d6c-46e9-49b6-a137-8933f0f05999",
  "datastoreId": "39b88a97-8247-4c0d-ba1d-8ed78d1a6680",
  "defaultPermissions": null,
  "requiredAuthorities": null,
  "owner": 870010733,
  "name": "users",
  "datasourceId": null,
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "username"
      },
      {
        "type": "STRING",
        "name": "email"
      }
    ]
  },
  "filters": null,
  "syncEnabled": true,
  "syncRequired": false,
  "fullReplaceRequired": false,
  "lastSync": null,
  "createdOn": "2024-01-15T18:42:30.115Z",
  "updatedOn": "2024-01-15T18:42:30.115Z",
  "updatedBy": 870010733
}

{
  "message": "Cannot find permission from source [USER:870010733] to target [MAGNUM_COLLECTION:a3f7d891-bc24-4e56-9a12-c7e3b0f845d2]. Permission Service reports that one or both does not exist",
  "status": 404,
  "statusReason": "Not Found",
  "toe": "RG3808D5LS-DHKE4-TG5EB"
}

Authorizations

X-DOMO-Developer-Token

string

header

required

Domo Developer Token for authentication.

Path Parameters

collectionId

string

required

The ID of the collection.

Response

string<uuid>

Unique identifier for the collection.

datastoreId

string<uuid>

ID of the datastore this collection belongs to.

defaultPermissions

any | null

Comma-separated default permission set for new app grants on this collection, or null if not set.

requiredAuthorities

any | null

Maps CollectionOperation names to required authority strings, or null if not set.

owner

integer

User ID of the collection owner.

name

string

Name of the collection.

datasourceId

string | null

ID of the linked Domo DataSet, or null if not yet linked.

schema

object

Show child attributes

filters

any | null

Array of document-level filter predicates applied to read operations, or null if not set.

syncEnabled

boolean

Whether documents are periodically synced to the linked DataSet.

syncRequired

boolean

Whether a sync is pending.

fullReplaceRequired

boolean

lastSync

string<date-time> | null

createdOn

string<date-time>

updatedOn

string<date-time>

updatedBy

integer

Getting Started

API Reference

Build Apps

Automate Actions

Partner Developers

AI Resources Guide

Connect Data

Embed Domo Everywhere

Govern Your Domo Instance

Other Resources

Developer Topics

Domo SDK

Get Collection

Authorizations

Path Parameters

Response