Accounts

List of valid attributes:

Attribute	Description	Specifics
created_at	Timestamp of creation	Cannot be set
discarded_at	Null or timestamp of removal	Cannot be set
name	Name of the account	-

Meta data: Permissions

Group	Description
account_membership	Contains permissions if account memberships can be managed
offboarding	Permissions if offboardings can be viewed, created or edited
onboarding	Permissions if onboardings can be viewed, created or edited
users	Permissions if users in account can be viewed or created

Show

Example response:

{
  "data": {
    "id": "98815bd8-f3e6-41ec-8c4a-25a431ac6ce4",
    "type": "account",
    "attributes": {
      ...
    }
  }
}

This endpoint returns a specific account.

HTTP Request

GET /api/v1/accounts/:account_id

URL Parameters

Parameter	Description
account_id	The ID of the account to retrieve

Create

Example request:

{
  "data": {
    "type": "account",
    "attributes": {
      "name": "New Account",
      "terms": {
        "accepted": true
      }
    }
  }
}

Example response:

{
  "data": {
    "id": "f4db9b2a-386e-4e17-9f04-b28c68048b34",
    "type": "identity",
    "attributes": {
      ...
    }
  }
}

This endpoint creates a new account for the currently logged in user.

HTTP Request

POST /api/v1/accounts

Arguments

Parameter	Description
name	Account name
terms.accepted	Must be true

Update

Example request:

{
  "data": {
    "type": "account",
    "attributes": {
      "name": "New Name"
    }
  }
}

Example response:

{
  "data": {
    "id": "98815bd8-f3e6-41ec-8c4a-25a431ac6ce4",
    "type": "account",
    "attributes": {
      ...
    }
  }
}

This endpoint updates a specific account.

HTTP Request

PUT /api/v1/accounts/:account_id

URL Parameters

Parameter	Description
account_id	The ID of the account to update