Skip to content
On this page

Account API

Account API endpoints

Every endpoint in version 1 of the Cycle API, with its fields and an example response.

Introduction

Paths are relative to your Cycle host, so /api/v1/user means https://cycle.am/api/v1/user. Every endpoint needs a bearer token with the read ability; see Personal tokens.

MethodPathEndpoint
GET/api/v1/userRetrieve the authenticated user
GET/api/v1/teamsList teams
GET/api/v1/teams/{team}Retrieve a team

The user object

Fields

idinteger
Unique ID of the user.
namestring
Full name.
emailstring
Email address the user signs in with.
email_verified_atstring | null
When the email address was verified (ISO 8601), or null if it has not been verified yet.
current_teamteam object | null
The team currently selected in the Cycle dashboard, as a team object.
created_atstring
When the account was created (ISO 8601).
updated_atstring
When the account was last changed (ISO 8601).

Retrieve the authenticated user

GET/api/v1/user
ability: read

Returns the user who owns the token, with their current team.

Request

curl https://cycle.am/api/v1/user \
  -H "Authorization: Bearer $CYCLE_API_TOKEN" \
  -H "Accept: application/json"

Response

Example response

200
{
  "data": {
    "id": 1,
    "name": "Ani Petrosyan",
    "email": "ani@example.com",
    "email_verified_at": "2026-11-02T09:31:12+00:00",
    "current_team": {
      "id": 1,
      "name": "Ani Petrosyan's Team",
      "slug": "ani-petrosyans-team",
      "is_personal": true,
      "role": "owner",
      "created_at": "2026-11-02T09:30:00+00:00",
      "updated_at": "2026-11-02T09:30:00+00:00"
    },
    "created_at": "2026-11-02T09:30:00+00:00",
    "updated_at": "2026-11-02T09:31:12+00:00"
  }
}

Errors

  • 401The token is missing, invalid or revoked.
  • 403The token does not have the read ability.
  • 429More than 60 requests in a minute.

The team object

Fields

idinteger
Unique ID of the team.
namestring
Team name.
slugstring
URL-safe name, used in /api/v1/teams/{team}. It changes when the team is renamed, so store the id if you need a stable reference.
is_personalboolean
true for the personal team every account gets when it signs up.
rolestring
Your role on the team: owner, admin, member.
created_atstring
When the team was created (ISO 8601).
updated_atstring
When the team was last changed (ISO 8601).

List teams

GET/api/v1/teams
ability: read

Returns every team you belong to, including your personal team, sorted by name. The list is not paginated.

Request

curl https://cycle.am/api/v1/teams \
  -H "Authorization: Bearer $CYCLE_API_TOKEN" \
  -H "Accept: application/json"

Response

Example response

200
{
  "data": [
    {
      "id": 1,
      "name": "Ani Petrosyan's Team",
      "slug": "ani-petrosyans-team",
      "is_personal": true,
      "role": "owner",
      "created_at": "2026-11-02T09:30:00+00:00",
      "updated_at": "2026-11-02T09:30:00+00:00"
    },
    {
      "id": 2,
      "name": "Yoga Studio",
      "slug": "yoga-studio",
      "is_personal": false,
      "role": "admin",
      "created_at": "2026-11-05T14:02:45+00:00",
      "updated_at": "2026-11-05T14:02:45+00:00"
    }
  ]
}

Errors

  • 401The token is missing, invalid or revoked.
  • 403The token does not have the read ability.
  • 429More than 60 requests in a minute.

Retrieve a team

GET/api/v1/teams/{team}
ability: read

Returns one team you belong to.

Path parameters

teamstringrequired
The team's slug, for example yoga-studio.

Request

curl https://cycle.am/api/v1/teams/yoga-studio \
  -H "Authorization: Bearer $CYCLE_API_TOKEN" \
  -H "Accept: application/json"

Response

Example response

200
{
  "data": {
    "id": 2,
    "name": "Yoga Studio",
    "slug": "yoga-studio",
    "is_personal": false,
    "role": "admin",
    "created_at": "2026-11-05T14:02:45+00:00",
    "updated_at": "2026-11-05T14:02:45+00:00"
  }
}

Errors

  • 401The token is missing, invalid or revoked.
  • 403The token does not have the read ability, or you are not a member of the team.
  • 404No team has this slug.
  • 429More than 60 requests in a minute.