GraphQL Reference · Done Bear

GraphQL Reference

Query and mutate Done Bear resources over the GraphQL endpoint, including tasks, projects, teams, labels, workspaces, and API keys.

The Done Bear GraphQL endpoint handles both reads and writes for tasks, projects, teams, labels, workspaces, and API keys.

Endpoint

Send POST requests to:


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{"query":"query { viewer { id email } }"}'

Common queries

`viewer`

Returns the currently authenticated user.

Published with Blode.md

curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "query { viewer { id email name username } }"
  }'


query Tasks($workspaceId: ID!) {
  tasks(first: 20, filter: { workspaceId: { eq: $workspaceId } }) {
    nodes {
      id
      title
      description
      start
      startBucket
      deadlineAt
      completedAt
      archivedAt
      projectId
      teamId
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "query Tasks($workspaceId: ID!) { tasks(first: 20, filter: { workspaceId: { eq: $workspaceId } }) { nodes { id title description start startBucket deadlineAt completedAt archivedAt projectId teamId } pageInfo { hasNextPage endCursor } } }",
    "variables": { "workspaceId": "<workspace-id>" }
  }'


# Logbook: completed and not archived, newest first.
tasks(
  first: 20
  filter: {
    workspaceId: { eq: $workspaceId }
    archivedAt: { null: true }
    completedAt: { null: false }
  }
  orderBy: { completedAt: DESC }
) {
  nodes {
    id
    title
    completedAt
  }
}


query Projects($workspaceId: ID!) {
  projects(first: 20, filter: { workspaceId: { eq: $workspaceId } }) {
    nodes {
      id
      key
      name
      status
      targetDate
      archivedAt
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "query Projects($workspaceId: ID!) { projects(first: 20, filter: { workspaceId: { eq: $workspaceId } }) { nodes { id key name status targetDate archivedAt } pageInfo { hasNextPage endCursor } } }",
    "variables": { "workspaceId": "<workspace-id>" }
  }'


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "query { myWorkspaces { id name urlKey role } }"
  }'


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "mutation CreateWorkspace($input: WorkspaceCreateInput!) { workspaceCreate(input: $input) { workspace { id name urlKey } } }",
    "variables": { "input": { "name": "My Team", "urlKey": "my-team" } }
  }'


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "mutation JoinWorkspace($code: String!) { workspaceJoin(code: $code) { workspace { id name } } }",
    "variables": { "code": "ABCD2345" }
  }'


query WorkspaceHistory($workspaceId: ID!, $limit: Int, $model: String) {
  workspaceHistory(workspaceId: $workspaceId, limit: $limit, model: $model) {
    id
    action
    model
    createdAt
  }
}


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "query WorkspaceHistory($workspaceId: ID!, $limit: Int, $model: String) { workspaceHistory(workspaceId: $workspaceId, limit: $limit, model: $model) { id action model createdAt } }",
    "variables": { "workspaceId": "<workspace-id>", "limit": 50 }
  }'


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "query { apiKeys { id label keyPrefix createdAt } }"
  }'


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "mutation CreateApiKey($label: String!) { apiKeyCreate(label: $label) { key { id label keyPrefix token createdAt } } }",
    "variables": { "label": "CI" }
  }'


curl https://api.donebear.com/graphql \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data '{
    "query": "mutation RevokeApiKey($id: ID!) { apiKeyRevoke(id: $id) { success } }",
    "variables": { "id": "<key-id>" }
  }'


mutation WorkspaceCreate($input: WorkspaceCreateInput!) {
  workspaceCreate(input: $input) {
    success
    errors {
      code
      message
      field
    }
    workspace {
      id
    }
  }
}