Get Team Group

GET

unified

hris

groups

teams

{id}

curl --request GET \
  --url https://api.stackone.com/unified/hris/groups/teams/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "name": "Engineering",
    "parent_ids": [
      "cxIQNjUyNDM0",
      "cxIQNjQzNzI0MQ"
    ],
    "remote_parent_ids": [
      "652434",
      "6437241"
    ],
    "owner_ids": [
      "cxIQNjUyEDM0",
      "cxIQNjQzNzA0MQ"
    ],
    "remote_owner_ids": [
      "475364",
      "4327652"
    ],
    "type": "team"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,name,type,parent_ids,remote_parent_ids,owner_ids,remote_owner_ids"

Response

200

application/json

The team group with the given identifier was retrieved.

data

object

required

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.name

string | null

The name of the group

Example:

"Engineering"

data.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.type

object

The type of the team group

Example:

"team"

raw

object[] | null

Was this page helpful?

Suggest edits

Get Group List Cost Center Groups

curl --request GET \
  --url https://api.stackone.com/unified/hris/groups/teams/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "name": "Engineering",
    "parent_ids": [
      "cxIQNjUyNDM0",
      "cxIQNjQzNzI0MQ"
    ],
    "remote_parent_ids": [
      "652434",
      "6437241"
    ],
    "owner_ids": [
      "cxIQNjUyEDM0",
      "cxIQNjQzNzA0MQ"
    ],
    "remote_owner_ids": [
      "475364",
      "4327652"
    ],
    "type": "team"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

HRIS

Common Guides

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response