Board Queries

Get Board

Retrieves information about your board. This query requires authentication via an API key in the headers.

Query Structure

query {
  board {
    id
    pid
    name
    description
    domain
    faviconUrl
    headerLink
    isRoadmapEnabled
    locale
    logoUrl
    team {
      id
      isInvitationPending
      role
      ssoId
    }
  }
}

Return Type

Returns a Board object with the following fields:

Field	Type	Description
id	String!	Unique identifier for the board
pid	String!	Also a unique identifier for the board. Used in nolt's official URL for your board
name	String!	Name of the board
description	String	Description of the board
domain	String	Custom domain field for your board
faviconUrl	String	URL of the board favicon
headerLink	String	URL of the board header link
isRoadmapEnabled	Boolean	Whether the roadmap is enabled
locale	String!	Locale of the board (e.g., en-US)
logoUrl	String	URL of the board logo
team	[TeamUser!]	List of users that are part of the board

TeamUser Type

The TeamUser type represents a user that is part of a team. They can be either invited or added.

Field	Type	Description
id	ID!	Unique identifier for the entry
isInvitationPending	Boolean	Is invitation pending for this user
role	BoardUserType	The role of the user in the team
ssoId	String	User's external id (admin and non external users will be null)

Example

query {
  board {
    id
    name
    description
    locale
    team {
      id
      role
      isInvitationPending
    }
  }
}

Example Response:

{
  "data": {
    "board": {
      "id": "board_123",
      "name": "Product Feedback",
      "description": "Collect and manage user feedback",
      "locale": "en-US",
      "team": [
        {
          "id": "user_1",
          "role": "ADMIN",
          "isInvitationPending": false
        }
      ]
    }
  }
}

Authentication

This query requires authentication. You must include your API key in the HTTP headers:

{
  "apikey": "YOUR_API_KEY"
}

You can also make requests using curl:

curl -X POST \
  -H "Content-Type: application/json" \
  -H "apikey: YOUR_API_KEY" \
  -d "query" \
  https://api.nolt.io/api/v1/graphql