Accounts

Endpoints related to managing your account on Cycle.

Get Account

Gets the Account associated with the authenticated bearer token.

SecuritybearerAuth

Responses

200

Returns the Account.

default

General error response from the platform

get/v1/account

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"name": {"first": "string",
"last": "string"
},
"email": {"address": "string",
"verified": true,
"added": "2021-01-30T08:30:00Z"
},
"two_factor_auth": {"verified": true
},
"allow_support_login": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
}

Update Account

Updates the Account.

SecuritybearerAuth and hubAuth

Request

Request Body schema: application/json

	object The new name on the Account.
allow_support_login	boolean If true, Cycle employees will have the ability, upon consent, to access the account for support purposes. This access will be logged.

Responses

200

Returns the updated Account.

default

General error response from the platform

patch/v1/account

Request samples

Payload

application/json

{"name": {"first": "string",
"last": "string"
},
"allow_support_login": true
}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"name": {"first": "string",
"last": "string"
},
"email": {"address": "string",
"verified": true,
"added": "2021-01-30T08:30:00Z"
},
"two_factor_auth": {"verified": true
},
"allow_support_login": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
}

Delete Account

Puts the Account into a deleted state. This will fail if the Account is the current OWNER of an active Hub.

SecuritybearerAuth and hubAuth

Responses

202

Returns a job descriptor with information about the status of the Account deletion.

default

General error response from the platform

delete/v1/account

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

Get Account Logins

Lists logins associated with a given account.

SecuritybearerAuth

Request

query Parameters

sort	Array of strings An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
filter	object
	object In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`

Responses

200

Returns a list of login records associated with this Account.

default

General error response from the platform

get/v1/account/logins

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"account": {"id": "651586fca6078e98982dbd90",
"ip": "string"
},
"time": "2021-01-30T08:30:00Z",
"type": "employee",
"success": true,
"employee": {"id": "651586fca6078e98982dbd90",
"ip": "string"
}
}
]
}

Change Password

Change the password on the Account. Requires the current password of the Account to be submitted.

SecuritybearerAuth

Request

Request Body schema: application/json

current required	string Current Password
new required	string >= 8 characters New Password

Responses

200

Returns an Account.

default

General error response from the platform

patch/v1/account/password

Request samples

Payload

application/json

{"current": "string",
"new": "stringst"
}

Response samples

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"name": {"first": "string",
"last": "string"
},
"email": {"address": "string",
"verified": true,
"added": "2021-01-30T08:30:00Z"
},
"two_factor_auth": {"verified": true
},
"allow_support_login": true,
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z",
"last_login": "2021-01-30T08:30:00Z"
}
}
}

Reset Password

Initiate a password reset for the Account. A confirmation email will be sent to the email associated with the Account, and the token in the email must be passed in a second call to this endpoint.

SecuritybearerAuth and hubAuth

Request

Request Body schema: application/json

One of:

required

object

Responses

200

Returns a simple object containing a success boolean.

default

General error response from the platform

post/v1/account/reset-password

Request samples

Payload

application/json

{"token": "string",
"password": "string"
}

Response samples

200
default

application/json

{"data": {"success": true
}
}

Enable Two-Factor Auth

Enables two-factor auth for the Account. Retrieve the token from an authenticator app using the secret from getTwoFactorAuthSetup.

SecuritybearerAuth and hubAuth

Request

Request Body schema: application/json

token

required

string

The token used to authenticate the two-factor setup.

Responses

200

Returns the recovery codes needed in case two-factor auth is no longer possible.

default

General error response from the platform

post/v1/account/2fa/setup

Request samples

Payload

application/json

{"token": "string"
}

Response samples

200
default

application/json

{"data": {"recovery_codes": ["string"
],
"totp_passcode": "string"
}
}

➔ Next to Memberships