Skip to main content
GET
https://api.tuesday.so
/
api
/
v1
/
public
/
auth
Check API Key
curl --request GET \
  --url https://api.tuesday.so/api/v1/public/auth \
  --header 'X-API-KEY: <x-api-key>'
{
    "data": {
        "name": "Joe's Workspace",
        "id": "ws30ngrb03luqxcl27",
        "user_id": "usr19g6tln8rlii8"
    },
    "statusCode": 200,
    "message": "Success"
}

​
Overview

Use this endpoint to verify that your API key is valid and retrieve information about your workspace. This is useful for testing your authentication setup before making other API calls.

​
Authentication

​
X-API-KEY
string
required
Your Tuesday API key. You can find this in your Tuesday Dashboard.

​
Response

​
data
object
​
statusCode
number
HTTP status code (200 for success)
​
message
string
Response message (“Success” for valid requests)

​
Example Request

curl --location 'https://api.tuesday.so/api/v1/public/auth' \
--header 'X-API-KEY: a285dcd7-7a91-42e2-ae37-9a91e72588b3'

​
Example Response

{
    "data": {
        "name": "Joe's Workspace",
        "id": "ws30ngrb03luqxcl27",
        "user_id": "usr19g6tln8rlii8"
    },
    "statusCode": 200,
    "message": "Success"
}

​
Error Responses

{
    "statusCode": 401,
    "message": "Unauthorized",
    "error": "API key is required"
}

{
    "statusCode": 401,
    "message": "Unauthorized",
    "error": "Invalid or missing API key"
}

​
Use Cases

Authentication Testing

Test your API key setup before integrating other endpoints

Health Checks

Monitor API connectivity and authentication status

Workspace Info

Retrieve workspace details for display in your application

Integration Setup

Verify credentials during initial integration setup

​
Next Steps

Once your API key is verified, you can start using the other Tuesday APIs: