Akter

Invitations

Invite a teammate by email: Akter emails the invitation, and the person signs in with that email and accepts it to become a member. An invitation lasts 7 days, and a new one to the same email replaces it.

List⁠

GEThttps://api.akter.dev/v1/organizations/{organization}/invitations
invitations.listBearer token

List an organization's pending invitations, a page at a time.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Query parameters

  • cursorstring

    The nextCursor of the previous page.

  • limitinteger

    At most this many items, 1 to 100. Defaults to 50.

Response 200InvitationPage

  • itemsInvitation[]required
  • items[].createdAtstringrequired
  • items[].emailstringrequired

    An email address, such as ada@example.com.

  • items[].expiresAtstringrequired
  • items[].idstringrequired

    An opaque id that starts with inv_.

  • items[].invitedBystringrequired

    An email address, such as ada@example.com.

  • items[].role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

  • nextCursorstring

    Pass as cursor for the next page.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Create⁠

POSThttps://api.akter.dev/v1/organizations/{organization}/invitations
invitations.createBearer token

Invite an email to the organization with a role, and email them the invitation.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Request bodyInvite

  • emailstringrequired

    An email address, such as ada@example.com.

  • role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

Response 201Invitation

  • createdAtstringrequired
  • emailstringrequired

    An email address, such as ada@example.com.

  • expiresAtstringrequired
  • idstringrequired

    An opaque id that starts with inv_.

  • invitedBystringrequired

    An email address, such as ada@example.com.

  • role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 409AlreadyExistsError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Revoke⁠

DELETEhttps://api.akter.dev/v1/organizations/{organization}/invitations/{invitation}
invitations.revokeBearer token

Revoke a pending invitation so it can no longer be accepted.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • invitationstringrequired

    An opaque id that starts with inv_.

Response 204<No Content>

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Accept⁠

POSThttps://api.akter.dev/v1/organizations/{organization}/invitations/{invitation}/accept
invitations.acceptBearer token

Accept an invitation sent to your email and join the organization with its role. Anyone else gets not found.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • invitationstringrequired

    An opaque id that starts with inv_.

Response 201Member

  • emailstringrequired

    An email address, such as ada@example.com.

  • idstringrequired

    An opaque id that starts with mem_.

  • joinedAtstringrequired
  • role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 409AlreadyExistsError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError