Groups

List Groups

Lists the available groups.

GET
/groups.list
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Query Parameters

created_by?array<string>

Filters the groups on the basis of creator.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
group_type?array<group-type>

Filters the groups based on the group type.

ingestion_source?array<group-ingestion-source>

Filter groups by ingestion source(s).

is_default?boolean

Whether to fetch default or custom groups.

limit?integer

The maximum number of groups to return. The default is '50'.

Formatint32
member_type?array<group-member-type>

Filters the groups on basis of member type.

mode?string

The iteration mode to use, otherwise if not set, then "after" is used.

Value in"after" | "before"
name?array<string>

Filters the groups on the basis of group name.

sort_by?array<string>

Comma-separated fields to sort the groups by.

sync_metadata.external_reference?array<string>

Filters for issues with this specific external reference.

sync_metadata.last_sync_in.status?array<sync-metadata-filter-sync-in-filter-status>

Filters for works with selected sync statuses.

sync_metadata.last_sync_in.sync_history?array<string>

Filters for works modified with selected sync history.

sync_metadata.last_sync_in.sync_unit?array<string>

Filters for works modified with selected sync units.

sync_metadata.last_sync_out.status?array<sync-metadata-filter-sync-out-filter-status>

Filters for works with selected sync statuses.

sync_metadata.last_sync_out.sync_history?array<string>

Filters for works modified with selected sync history.

sync_metadata.last_sync_out.sync_unit?array<string>

Filters for works modified with selected sync units.

sync_metadata.origin_system?array<string>

Filters for issues synced from this specific origin system.

Response Body

curl -X GET "https://api.devrev.ai/groups.list?created_by=string&cursor=string&group_type=dynamic&ingestion_source=airdrop&is_default=true&limit=0&member_type=dev_user&mode=after&name=string&sort_by=string&sync_metadata.external_reference=string&sync_metadata.last_sync_in.status=failed&sync_metadata.last_sync_in.sync_history=string&sync_metadata.last_sync_in.sync_unit=string&sync_metadata.last_sync_out.status=failed&sync_metadata.last_sync_out.sync_history=string&sync_metadata.last_sync_out.sync_unit=string&sync_metadata.origin_system=string"
{
  "groups": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z"
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}