List Tulip App Groups and the Apps they contain
  • 04 Mar 2025
  • 1 Minute to read
  • Contributors

List Tulip App Groups and the Apps they contain


Article summary

Get
/appGroups

Retrieves a list of all Tulip App Groups and their containing apps.

Requires the apps:read API key scope.

Security
HTTP
Type basic

Access to the Tulip API requires the use of HTTP Basic Authentication using the credentials of an active Tulip API Token. All requests require the Authorization HTTP header with the Basic scheme to provide API credentials unless otherwise noted.

API tokens can be configured with a set of scopes which determine what parts of the API that specific token has access to. Security best practices dictate that API credentials be given the minimum set of capabilities required to fulfill their intended purpose. For example, an API token created for use in an integration that is only designed to use the Tables API should probably only be given the tables:read and tables:write scopes. In this way you can minimize risk in the event that API credentials are compromised. API endpoints will document what API token scopes are required to access that endpoint in their descriptions. If a request is made to an endpoint with an API token which does not have the required scopes, the response will be an authorization error.

Responses
200

The list of Tulip App groups was retrieved successfully.

Array of object
object
Example{ "id": "xMHMG2s98r6BvYSxB", "name": "MFG Apps", "parent": "7gG89VedgchjagVds", "apps": [ { "id": "EyCK9rM8FLj5uwspA", "name": "Machine Maintenance", "type": "group" }, { "id": "D9Gvdd9S9xgX81md7", "name": "Frame Assembly", "type": "app", "persistentId": "Ac4gHT59iiL3GHldq", "published": true } ] }
id
Exampleg56RCoZCtzv7borvp
name
string
parent
Exampleg56RCoZCtzv7borvp
contents
Array of object

A list of objects which describing the groups or apps contained by an App Group. If type is "group" then there is no "published" as a group does not have the published state. If the type is "app" it will have published only if it is published.

object
id
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
name
string
type
string
Valid values[ "app", "group" ]
persistentId
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
published
boolean
400

The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
401

The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
403

The provided authentication info was rejected. The response will provide additional details.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string
500

The server encountered an unexpected error.

object
errorCode
string
errorUniqueID
string
Pattern^[a-zA-Z0-9+/]+$
Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
details
string

Was this article helpful?