Skip to main content
GET
/
api
/
r2r
/
v3
/
collections
/
name
/
{collection_name}
Get collection by name
curl --request GET \
  --url https://api.intelligence.io.solutions/api/r2r/v3/collections/name/{collection_name} \
  --header 'Authorization: Bearer <token>'
{
  "results": {
    "id": "id",
    "name": "name",
    "graph_cluster_status": "graph_cluster_status",
    "graph_sync_status": "graph_sync_status",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "user_count": 1,
    "document_count": 1,
    "owner_id": "owner_id",
    "description": "description"
  }
}
The authenticated user can only fetch collections they own, or, if superuser, from anyone.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

collection_name
string
required

The name of the collection

Query Parameters

owner_id
string
default:format: "uuid"

(Superuser only) Specify the owner_id to retrieve a collection by name

Response

200

results
object
I