Groups

Endpointhttps://api.idol.io/api/v2

Group (account/organization) management.

Groups represent organizational units within Labelcamp. They can be nested (parent/child), have expiration dates, and control access to resources through ACLs.

List groups

GET

https://api.idol.io/api/v2

/groups

Retrieve a paginated list of groups. Returns groups managed by the authenticated user.

List groups › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

filter[parent-id]

string

Filter by parent group ID

filter[active]

boolean

Filter to active groups only (expiration in the future or not set)

filter[distributor-id]

string

Filter by distributor ID

List groups › Responses

Successful response

object[]

object

object[]

Create a group

POST

https://api.idol.io/api/v2

/groups

Create a new group.

Create a group › Request Body

object · required

Create a group › Responses

Group created successfully

object

object[]

POST/groups

curl --request POST \
  --url https://api.idol.io/api/v2/groups \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "groups",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "groups",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get a group

GET

https://api.idol.io/api/v2

/groups/{id}

Retrieve a single group by ID.

Get a group › path Parameters

id

string · required

Resource ID

Get a group › query Parameters

include

string

Comma-separated list of related resources to include

Get a group › Responses

Successful response

object

object[]

Update a group

PATCH

https://api.idol.io/api/v2

/groups/{id}

Update a group's name or expiration date.

Update a group › path Parameters

id

string · required

Resource ID

Update a group › Request Body

object · required

Update a group › Responses

Group updated successfully

object

object[]

PATCH/groups/{id}

curl --request PATCH \
  --url https://api.idol.io/api/v2/groups/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "groups",
    "id": "id",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "groups",
    "id": "id",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Users Distributors

Labelcamp API v2

Groups

Endpointhttps://api.idol.io/api/v2

Group (account/organization) management.

Groups represent organizational units within Labelcamp. They can be nested (parent/child), have expiration dates, and control access to resources through ACLs.

List groups

GET

https://api.idol.io/api/v2

/groups

Retrieve a paginated list of groups. Returns groups managed by the authenticated user.

List groups › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

include

string

Comma-separated list of related resources to include

filter[parent-id]

string

Filter by parent group ID

filter[active]

boolean

Filter to active groups only (expiration in the future or not set)

filter[distributor-id]

string

Filter by distributor ID

List groups › Responses

Successful response

object[]

object

object[]

Create a group

POST

https://api.idol.io/api/v2

/groups

Create a new group.

Create a group › Request Body

object · required

Create a group › Responses

Group created successfully

object

object[]

POST/groups

curl --request POST \
  --url https://api.idol.io/api/v2/groups \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "groups",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "groups",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "groups",
          "id": "id"
        }
      },
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Get a group

GET

https://api.idol.io/api/v2

/groups/{id}

Retrieve a single group by ID.

Get a group › path Parameters

id

string · required

Resource ID

Get a group › query Parameters

include

string

Comma-separated list of related resources to include

Get a group › Responses

Successful response

object

object[]

Update a group

PATCH

https://api.idol.io/api/v2

/groups/{id}

Update a group's name or expiration date.

Update a group › path Parameters

id

string · required

Resource ID

Update a group › Request Body

object · required

Update a group › Responses

Group updated successfully

object

object[]

PATCH/groups/{id}

curl --request PATCH \
  --url https://api.idol.io/api/v2/groups/:id \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "groups",
    "id": "id",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "groups",
    "id": "id",
    "attributes": {
      "name": "name",
      "expiration": "2024-08-25"
    },
    "relationships": {
      "language": {
        "data": {
          "type": "languages",
          "id": "id"
        }
      }
    }
  }
}

json

Example Responses

No example specified for this content type

application/vnd.api+json

Users Distributors