The team object

• object string: "team"

• id uuid

• url string

• name string

• createdAt date

• createdUserId uuid

Get teams

Endpoint: GET /v0/teams

Query parameters:

• limit integer (optional, default: 100): Number between 1 and 100 to limit the results.

• after uuid (optional): Only return workspaces that come after the given workspace ID (used for pagination usually in combination with the limit parameter).

Example request

curl https://api.nuclino.com/v0/teams?limit=2 \
  -H "Authorization: YOUR_API_KEY"

Example response

{
  "status": "success",
  "data": {
    "object": "list",
    "results": [
      {
        "object": "team",
        "id": "020f9737-7b21-442b-85eb-bd420e5593b2",
        "url": "https://app.nuclino.com/Team-One",
        "name": "Team One",
        "createdAt": "2021-10-21T09:34:47.885Z",
        "createdUserId": "2e96f3bb-c742-4164-af2c-151ab2fd346b"
      },
      {
        "object": "team",
        "id": "2e5474ad-c433-4a02-9bde-5455a12d025f",
        "url": "https://app.nuclino.com/Team-Two",
        "name": "Team Two",
        "createdAt": "2021-11-29T14:21:30.052Z",
        "createdUserId": "2e96f3bb-c742-4164-af2c-151ab2fd346b"
      }
    ]
  }
}

Get team

Endpoint: GET /v0/teams/:id

Example request

curl https://api.nuclino.com/v0/teams/020f9737-7b21-442b-85eb-bd420e5593b2 \
  -H "Authorization: YOUR_API_KEY"

Example response

{
  "status": "success",
  "data": {
    "object": "team",
    "id": "020f9737-7b21-442b-85eb-bd420e5593b2",
    "url": "https://app.nuclino.com/Team-One",
    "name": "Team One",
    "createdAt": "2021-10-21T09:34:47.885Z",
    "createdUserId": "2e96f3bb-c742-4164-af2c-151ab2fd346b"
  }
}