Who can use the API?

What we need

[] API Token

Admins and members have access to their own API tokens. Guests cannot access an API key but can utilize API features through other authentication methods, like OAuth or a shortLivedToken.

Viewers, users who have been deactivated or disabled, users with unconfirmed emails, or users on student accounts cannot access the API.

Follow these steps to create a Monday API token for accessing the Monday GraphQL endpoint:

1. Log in to your Monday.com account

   • Visit the Monday.com website and sign in with your credentials.
   • Make sure you have the necessary permissions to create API tokens.

2. Access your API token

   For admin users:

   • Click on your avatar/profile picture in the top right corner.
   • Select Administration > Connections > API.
   • Copy your personal token. Note that regenerating a new token will cause any previous tokens to expire.

   For member users or admins (alternative method):

   • Click on your profile picture in the top right corner.
   • Select Developers. This will open the Developer Center in another tab.
   • Click My Access Tokens > Show.
   • Copy your personal token. Note that regenerating a new token will cause any previous tokens to expire.

3. Use the token with Bearer Authentication The token is used with Bearer Authentication in the following format:

Authorization: YOUR_MONDAY_API_TOKEN

4. Test your token in the API Playground
   • Visit the Monday API Playground
   • Enter your API token when prompted
   • Try a simple query to verify your token works:

query {
  me {
    name
    email
  }
}

GraphQL Endpoint

Monday.com uses a single GraphQL endpoint for all API operations:

https://api.monday.com/v2

All queries and mutations should be sent to this endpoint with your API token in the Authorization header.

Permissions

The API token grants access based on your Monday.com user permissions. Your token inherits the same permissions you have in the Monday.com UI, including:

• Access to boards and workspaces you can view
• Ability to create, update, or delete items based on your permissions
• Access to users and teams you can view

Item Checklist of what’s needed for integration

1. Monday.com API token
2. GraphQL endpoint URL: https://api.monday.com/v2

Required Permissions

To use the Monday API effectively, your Monday.com user account should have:

• Access to the boards and items you need to work with
• Appropriate permissions for the operations you want to perform

Concrete required scopes:

• for Users: users:read
• for Teams: teams:read

Limits

Monday.com API has different types of limits in place.

Complexity limit

Daily call limit

Minute limit

Concurrency limit

IP limit

Common GraphQL Operations

Here are some common operations you might perform with the Monday.com API:

Query boards

query {
  boards {
    id
    name
    columns {
      id
      title
      type
    }
  }
}

Create a new item

mutation {
  create_item(board_id: YOUR_BOARD_ID, item_name: "New Item") {
    id
    name
  }
}

Update a column value

mutation {
  change_column_value(
    board_id: YOUR_BOARD_ID,
    item_id: YOUR_ITEM_ID,
    column_id: "status",
    value: "{\"index\": 1}"
  ) {
    id
  }
}