Get collection details

GET 
/api/v1/collections/:collection-id

Get collection details.

Request

Path Parameters

collection-id stringrequired

Collection ID

Responses

200

Successful response

application/json

Schema

Schema

result

object

required

name stringrequired

Collection name

created_at stringrequired

Timestamp when the collection was created

search_queries numberrequired

Count of searches performed on the collection thus far

Example (from schema)

{
  "result": {
    "name": "string",
    "created_at": "string",
    "search_queries": 0
  }
}

401

Unauthorized

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

403

Forbidden

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

404

Not found

application/json

Schema

Schema

error

object

required

message stringrequired

Human readable error message

data nullable

Further details on the error

Example (from schema)

{
  "error": {
    "message": "string"
  }
}

Loading...