Accounts

GET /v1/account

Description

Get account info for the current user.

• If using Authorization header, the endpoint will lookup the account ID of the user that created the API token

• If using a JWT, the endpoint will use sub as the account ID

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Example Response

{
   "id":"d59d88ee-6a78-495d-872b-96d2799fd2f1",
   "name":"Dade Murphy",
   "email":"[e-mail]",
   "rounded_corners":true,
   "onboarding_state":"CLOSED",
   "onboarding_state_status":"PROCESSING",
   "team":{
      "id":"765f94d5-e61d-4043-a4a2-af5913d00f3d",
      "name":"Batch"
   },
   "available_teams":[
      {
         "id":"765f94d5-e61d-4043-a4a2-af5913d00f3d",
         "name":"Batch"
      }
   ]
}

GET /v1/account/team

Description

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Example Response

[
  {
    "id": "224b0741-df62-457e-a8c0-29f5fdf6cd65",
    "name": "batchtest-1"
  }
]

PUT /v1/account/team

Description

A new JWT will be returned along with a payload of account data, same as /v1/login:`

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

Example Response

{
    "id": "30da7b29-8a8d-470e-a94a-dce003018a01",
    "name": "mark test",
    "email": "[e-mail]",
    "rounded_corners": true,
    "onboarding_state": "PENDING",
    "onboarding_state_status": "PROCESSING",
    "team": {
        "id": "b752731f-5af4-41cd-a810-535d5e32ca5f",
        "name": "test-1234"
    },
    "available_teams": [
        {
            "id": "b752731f-5af4-41cd-a810-535d5e32ca5f",
            "name": "test-1234"
        },
        {
            "id": "7cf162ac-ea51-4095-9eab-d36241ef2bf0",
            "name": "test-123"
        }
    ]
}

PUT /v1/account/change-password

Description

Change user password.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

PUT /v1/account/profile

Description

Update profile.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
email	string	no	Email associated with the account
name	string	no	Name associated with the account
rounded_corners	bool	no	Some people are very passionate about rounded corners and vice versa;

Example Response

{
   "id":"d59d88ee-6a78-495d-872b-96d2799fd2f1",
   "name":"Dade Murphy",
   "email":"[e-mail]",
   "rounded_corners":true,
   "onboarding_state":"CLOSED",
   "onboarding_state_status":"PROCESSING",
   "team":{
      "id":"765f94d5-e61d-4043-a4a2-af5913d00f3d",
      "name":"Batch"
   },
   "available_teams":null
}

PUT /v1/account/onboarding

Description

Update onboarding state.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Body Parameters

Param	Type	Required	Description
TODO	string	yes	Bearer token containing API key

Example Response

{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}

GET /v1/tasks

Description

Get async tasks for account.

Header Parameters

Param	Type	Required	Description
Authorization	string	yes	Bearer token containing API key

Example Response

{"data":[]}