List Tulip App Groups and the Apps they contain
  • 01 Oct 2024
  • 2 Minutes 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

A Tulip API key is required to use the Tulip API. API key authentication uses HTTP Basic Authentication as defined by RFC 7617. HTTP Basic Authentication uses a generic username/password scheme to authenticate. For Tulip API requests, the password should be the API key's associated secret. The username should have the format {type}.{version}_{id}, where {type} is the API key type, {version} is the type's version number, and {id} is the id of the key. Tulip API keys currently are one of two types:

  • apikey.2 - user API keys provisioned by creating a Tulip API Token. The key id is the token id.
  • onetime.1 - temporary API keys provisioned using the /auth/temporary endpoint or using the One-Time API Key page. These keys are only valid for 30 seconds after provisioning.

Once you have determined the username and password you need to use, the Authorization header should be set to the value Basic {credentials}, where {credentials} is the base64-encoded value of the string {username}:{password}. See RFC 7617 for more details of this encoding.

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
string
Pattern^[a-zA-Z0-9_]+$
Exampleg56RCoZCtzv7borvp
name
string
parent
string
Pattern^[a-zA-Z0-9_]+$
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
errorCode
Valid values[ "AuthenticationRequired" ]
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
errorCode
Valid values[ "AuthenticationFailed" ]
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?