Returns a collection

Returns a collection

GET /collections/{collectionId}

Returns a collection

cURL

curl --request GET \
  --url https://api.inorbit.ai/collections/{collectionId} \
  --header 'x-auth-inorbit-app-key: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "collectionId": "<string>"
    }
  ]
}

Authorizations

x-auth-inorbit-app-key · string · header · required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Path Parameters

collectionId · string · required

The collection id

Response

200

application/json

The collection object

A collection that can be used to group robots using a set of tags

id · string · required

Unique identifier of the collection

name · string · required

Collection name

tags · object[] · required

List of tags defined for this collections

Show child attributes