Retrieve a paginated list of groups | Coactive AI

curl https://app.coactive.ai/api/v3/dynamic-tags/groups \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "group_version_id": "7b9c9f1e-4d3a-4f2a-9f3e-1a2b3c4d5e6f",
      "name": "Wildlife Species Tags",
      "status": "creating",
      "shareable": true,
      "created_user_id": "user_12345",
      "updated_user_id": "user_12345",
      "created_dt": "2024-01-15T09:30:00Z",
      "updated_dt": "2024-01-15T09:30:00Z",
      "group_created_user_id": "user_12345",
      "group_created_dt": "2023-12-01T08:00:00Z",
      "tags_preview": [
        {
          "tag_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "tag_version_id": "b2c3d4e5-f678-90ab-cdef-1234567890ab",
          "name": "Elephant",
          "status": "creating"
        }
      ],
      "tags_count": 42,
      "all_draft_tags_reviewed_dt": "2024-01-14T16:45:00Z",
      "review_tags_visited_at": "2024-01-14T15:00:00Z",
      "version_name": "v1.0.0",
      "group_description": "Tags for identifying various wildlife species in video footage.",
      "training_datasets": [
        {
          "id": "d4e5f678-90ab-cdef-1234-567890abcdef",
          "status": "unscored"
        }
      ]
    }
  ],
  "meta": {
    "page": {
      "page": 1,
      "per_page": 25
    },
    "has_next_page": false
  },
  "sort": [
    {
      "field": "name",
      "direction": "asc"
    }
  ]
}

Retrieves a paginated list of dynamic tag groups. Supports filtering by name, version name, or status.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

namestring or nullOptional

Filter by group name

name_containsstring or nullOptional

Filter by group name containing this string

version_namestring or nullOptional

Filter by version name

group_statusenum or nullOptional

Filter by status

group_idslist of strings or nullOptional

Filter by group IDs

visual_encoderstring or nullOptional

Filter by visual encoder

transcript_encoderstring or nullOptional

Filter by transcript encoder

exclude_group_idslist of strings or nullOptional

Exclude groups with these IDs

is_shareablebooleanOptionalDefaults to false

Whether to return only shareable groups

created_user_idstring or nullOptional

Filter by user who created the group

created_dt_fromstring or nullOptionalformat: "date-time"

Filter groups created on or after this date

created_dt_tostring or nullOptionalformat: "date-time"

Filter groups created before this date

training_dataset_idstring or nullOptionalformat: "uuid"

Filter by associated training dataset ID

pageintegerOptional>=1Defaults to 1

Page number (1-indexed)

per_pageintegerOptional1-100Defaults to 25

Number of items per page

sort_fieldstringOptionalDefaults to name

Field to sort by

sort_directionenumOptional

Sort direction

Allowed values:

include_training_datasetsbooleanOptionalDefaults to false

Include at most 10 associated datasets in the response

include_versionsbooleanOptionalDefaults to false

Include the latest draft and published versions of the group in the response

include_tagsbooleanOptionalDefaults to false

Include at most 10 tag names in the response

Response

Successful Response

datalist of objects

The paginated data

metaobject or null

Metadata for pagination

sortlist of objects or null

Sort details

Errors

422

Unprocessable Entity Error