1. Reference
  2. Web API
  3. Directories

Directories

Api for directories.

Get directory

GET /api/directories/{id}

Get a directory by id.

Sample request

$ curl {WEAVY_SERVER}/api/directories/1
-H "Authorization: Bearer {ACCESS_TOKEN | WEAVY_APIKEY}"

Parameters

Name Type Required Description
id integer True Id of directory.

Responses

Status code 200

application/json

{
  "id": "integer",
  "name": "string",
  "member_count": "integer"
}
Status code 404

application/json

{
  "type": "string",
  "title": "string",
  "status": "integer",
  "detail": "string",
  "instance": "string"
}

Get directory by name

GET /api/directories/{name}

Get a directory by name.

Sample request

$ curl {WEAVY_SERVER}/api/directories/directory-1
-H "Authorization: Bearer {ACCESS_TOKEN | WEAVY_APIKEY}"

Parameters

Name Type Required Description
name string True Name of directory.

Responses

Status code 200

application/json

{
  "id": "integer",
  "name": "string",
  "member_count": "integer"
}

List directories

GET /api/directories

List directories.

Sample request

$ curl {WEAVY_SERVER}/api/directories?top=10&q=acme
-H "Authorization: Bearer {ACCESS_TOKEN | WEAVY_APIKEY}"

Parameters

Name Type Required Description
q string False
tag string False
trashed boolean False
order_by string False
top integer False
skip integer False
count boolean False
count_only boolean False

Responses

Status code 200

application/json

{
  "data": [
    "object"
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}

List directory members

GET /api/directories/{id}/members

List the members of a directory.

Sample request

$ curl {WEAVY_SERVER}/api/directories/1/members
-H "Authorization: Bearer {ACCESS_TOKEN | WEAVY_APIKEY}"

Parameters

Name Type Required Description
id integer True Directory id.
directory_id integer False
suspended boolean False
q string False
tag string False
trashed boolean False
order_by string False
top integer False
skip integer False
count boolean False
count_only boolean False

Responses

Status code 200

application/json

{
  "data": [
    "object"
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}
Weavy Docs