Get an agent group by ID

GET

/v1/agent-groups/{id}

curl --request GET \
  --url https://example.com/v1/agent-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• this engine

Returns one agent group. Authorization runs against the GROUP entity so a workspace-confined operator cannot read a cross-workspace group.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

id

required

string format: uuid

Resource identifier (UUIDv7).

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

200

OK

Media type application/json

object

created_at

required

string format: date-time

description

string

id

required

string format: uuid

metadata

object

key

additional properties

any

name

required

string

slug

required

The stable scope handle ([a-z0-9][a-z0-9-]*, max 63).

string

status

required

string

Allowed values: active inactive

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer format: int64

workspace_id

The group’s workspace scope; absent when tenant-wide.

string format: uuid

Example

{
  "status": "active"
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}