Accounts

An account holds an organization's people, projects and buckets. Accounts are addressed by ID, like everything else in v4. An account ID is a UUID. GET /v4/accounts lists the accounts you can use, and its name filter finds an account's ID from the name the portal shows.

List accounts

GET

https://dev-api-v4-main-a471234.zuplo.app

/v4/accounts

Lists the accounts the caller can use, oldest first: every account the signed-in person is a member of, or the one account of an API key. Filter by name to find an account's ID from the name the portal shows.

List accounts › query Parameters

name

string · maxLength: 128

Only return the account with this name.

limit

integer · min: 1 · max: 100

The maximum number of items to return.

Default: 10

offset

integer · min: 0

The number of items to skip before the first item returned.

Default: 0

List accounts › Responses

A page of accounts.

AccountList

Account[] · required

The accounts on this page.

limit

integer · required

The page size that was applied.

offset

integer · required

The number of items skipped before this page.

total

integer · required

The number of items in the whole collection.

hasMore

boolean · required

Whether there are more items after this page.

next

string | null · required

The relative URL of the next page, or null on the last page.

Get an account

GET

https://dev-api-v4-main-a471234.zuplo.app

/v4/accounts/{accountId}

Returns an account's ID and name.

Get an account › path Parameters

accountId

string · maxLength: 64 · required

The account ID, a UUID.

Get an account › Responses

The account.

An account: the people, projects and buckets of one organization, and its plan. It is addressed by `id`. Its `name` is what the portal shows.

Account

id

string · required

The account ID.

Example: 5f0c7c2e-8d3a-4b1e-9f2a-6c1d0e7b3a49

name

string · required

The account's name, unique across Zuplo. The portal shows it, and v1 URLs use it. Address the account by id.

Example: acme-corp

createdOn

string | null · date-time · required

When the account was created. Null when Zuplo has no record of it, which can be the case for accounts created before it was recorded.

Account Members