Skip to main content
This API allows interaction with various Domo data operations, including retrieving, creating, and managing accounts.

​
GET Account by ID

Playground

 Method: GET
Endpoint: /api/data/v1/accounts/{account_id} Example: 
{
	"method": "GET",
	"url": "https://{domo_instance}.domo.com/api/data/v1/accounts/{account_id}",
	"headers": {
		"X-DOMO-Developer-Token": "",
		"Content-Type": "application/json"
	},
	"body": {}
}
Parameters:
Property NameTypeRequiredDescription
account_idStringyesThe unique identifier for the account.
Response:
Description of the Response with an example of the data 
HTTP/1.1 200 OK
  Content-Type: application/json;charset=UTF-8
  {
    "accountId": "{account_id}",
    "displayName": "Account Display Name",
    "status": "Active"
  }

​
GET all accounts

Playground

 Method: GET
Endpoint: /api/data/v1/accounts/ Example: 
{
	"method": "GET",
	"url": "https://{domo_instance}.domo.com/api/data/v1/accounts/",
	"headers": {
		"X-DOMO-Developer-Token": "",
		"Content-Type": "application/json"
	},
	"body": {}
}
Response:
Description of the Response with an example of the data 
HTTP/1.1 200 OK
  Content-Type: application/json;charset=UTF-8
  [
    {
      "accountId": "{account_id}",
      "displayName": "Account 1"
    },
    {
      "accountId": "{account_id}",
      "displayName": "Account 2" 
    }
  ]

​
Search Accounts by Name

Playground

 Method: POST
Endpoint: /api/search/v1/query Example: 
{
	"method": "POST",
	"url": "https://{domo_instance}.domo.com/api/search/v1/query",
	"headers": {
		"X-DOMO-Developer-Token": "",
		"Content-Type": "application/json"
	},
	"body": {
		"count": 100,
		"offset": 0,
		"combineResults": false,
		"query": "*sdk*",
		"filters": [],
		"facetValuesToInclude": [
			"DATAPROVIDERNAME",
			"OWNED_BY_ID",
			"VALID",
			"USED",
			"LAST_MODIFIED_DATE"
		],
		"queryProfile": "GLOBAL",
		"entityList": [
			["account"]
		],
		"sort": {
			"fieldSorts": [
				{
					"field": "display_name_sort",
					"sortOrder": "ASC"
				}
			]
		}
	}
}
Parameters:
Property NameTypeRequiredDescription
countNumbernoHow many results to return, default is 10
offsetNumbernoThe results offset, default is 0
queryStringyesThe search query string
filtersArray of FilternoFilters to apply to the search.
facetValuesToIncludeArray of StringnoFacet values to include in the search results.
queryProfileStringnoThe query profile to use (e.g., GLOBAL)
entityListArray of ArrayyesThe entity list to search within (e.g., ["account"])
sortObjectnoSort options, including the field and order.
Response:
Description of the Response with an example of the data 
HTTP/1.1 200 OK
  Content-Type: application/json;charset=UTF-8
  {
    "results": [
      {
        "accountId": "{account_id}",
        "displayName": "SDK Account",
        "status": "Active"
      }
    ]
  }

​
Create Account

Playground

 Method: POST
Endpoint: /api/data/v1/accounts Example: 
{
	"method": "POST",
	"url": "https://{domo_instance}.domo.com/api/data/v1/accounts",
	"headers": {
		"X-DOMO-Developer-Token": "",
		"Content-Type": "application/json"
	},
	"body": {
		"displayName": "New Account",
		"accountType": "Standard"
	}
}
Parameters:
Property NameTypeRequiredDescription
displayNameStringyesThe name of the new account.
accountTypeStringyesThe type of account (e.g., “Standard”).
Response:
Description of the Response with an example of the data 
HTTP/1.1 200 OK
  Content-Type: application/json;charset=UTF-8
  {
    "accountId": "{account_id}",
    "displayName": "New Account",
    "status": "Active"
  }