organization 0.7.40

Organizations define the actual groups using Flow, enabling account administration and defining who has access to the Flow platform

  • Contact: N/A
  • License: N/A

Resources

invitation

Operations

Method and Path Description
GET /invitations

Search invitations. Always paginated.

GET /invitations/versions
GET /invitations/:id

Returns information about a specific invitation.

POST /invitations

Create a new invitation.

GET /invitations/tokens/:token

Lookup an invitation by its token.

PUT /invitations/tokens/:token

Accepts the invitation w/ the specified token and the authenticated user. Creating a membership record for this user within this organization. Invitations are one time use only - you will get a validation error if the invitation has previously been accepted or if the user’s email addresses do not match the email on the invite.

DELETE /invitations/:id

io.flow.common.v0.models.organization

Operations

Method and Path Description
GET /organizations

Search organizations. Always paginated.

GET /organizations/versions

Provides visibility into recent changes of each object, including deletion

GET /organizations/:organization_id

Returns information about a specific organization.

GET /organizations/:organization_id/settings/currencies

Returns currencies for a specific organization.

GET /organizations/:organization_id/settings/regions/countries/available

Returns the list of enabled countries based on the region settings for a specific organization

GET /organizations/:organization_id/settings/regions

Returns the region settings associated to a specific organization.

PUT /organizations/:organization_id/settings/regions/:region

Updates or creates a region setting for a specific organization

DELETE /organizations/:organization_id/settings/regions/:region

Removes the setting for this region for a specific organization

POST /organizations

Create a new organization.

PUT /organizations/:organization_id

Update or create an organization with the specified id.

DELETE /organizations/:organization_id

Delete the organization with this id

membership

Operations

Method and Path Description
GET /memberships

Search memberships. Always paginated.

GET /memberships/versions
GET /memberships/:id

Returns information about a specific membership.

POST /memberships

Create a new membership.

PUT /memberships/:id

Change the role for a specific membership record. If the user already has the specified role within the organization, does nothing.

DELETE /memberships/:id

organization_authorization

Operations

Method and Path Description
POST /organization-authorizations

For the authorized user, if the specified organization exists, and the user is an active member of this organization, returns the authorization data used throughout APIs at Flow, including the user’s role in that organization and the organization environment. Otherwise, returns 401 - this indicates either the org does not exist or the user does not have access to the org.

deprecated:

Use GET /:organization/permission/checks

GET /organization-authorizations/:organization

For the authorized user and specific organization, if the user is an active member of this organization, returns the authorization data used throughout APIs at Flow, including the user’s role in that organization and the organization environment.

deprecated:

Use GET /:organization/permission/checks

organization_default_configurations

Operations

Method and Path Description
GET /:organization_id/default/configurations
PUT /:organization_id/default/configurations/checkout

Update the default checkout configuration id for this organization

Headers

No headers

Imports

https://app.apibuilder.io/flow/common/latest/service.json
https://app.apibuilder.io/flow/error/latest/service.json
https://app.apibuilder.io/flow/permission/latest/service.json
https://app.apibuilder.io/flow/reference/latest/service.json

Enums

configuration_type

Name Value Description
default default

variant variant

invitation_error_code

Name Value Description
expired expired

invalid_email invalid_email

Models

invitation

Example Json: Minimal | Full

An invitation via email to a user to join this organization. The user will then walk through a user login/registration process and will immediately become a member of the organization.

Field Type Required? Default Description Annotations
id string Yes -

organization io.flow.common.v0.unions.expandable_organization:0.7.56 Yes -

email string Yes -

The email address to which we send this invitation

personal_data

name io.flow.common.v0.models.name:0.7.56 Yes -

personal_data

role io.flow.common.v0.enums.role:0.7.56 No -

deprecated:

Static roles are being deprecated for role-based permissions.

personal_data

roles [io.flow.permission.v0.unions.flow_role:0.7.56] No -

The desired role(s) this user will play for the organization

personal_data

expiration date-time-iso8601 Yes -

The date / time on which this token expires. Current default is for tokens to live for 1 week

invitation_error

Example Json: Minimal | Full

Returns information as to why a particular invitation could not be accepted.

Field Type Required? Default Description Annotations
code invitation_error_code Yes -

messages [string] Yes -

Minimum: 1

invitation_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
organization string Yes -

email string Yes -

personal_data

name io.flow.common.v0.models.name:0.7.56 No -

personal_data

role io.flow.common.v0.enums.role:0.7.56 Yes member

deprecated:

Static roles are being deprecated for role-based permissions.

personal_data

roles [io.flow.permission.v0.unions.flow_role:0.7.56] No -

The desired role(s) this user will play for the organization

personal_data

invitation_version

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

timestamp date-time-iso8601 Yes -

type io.flow.common.v0.enums.change_type:0.7.56 Yes -

invitation invitation Yes -

membership

Example Json: Minimal | Full

Represents the users that are part of this organization. Primary purpose is to manage which users have access to the organization’s data and to provide a simple user interface to assign roles and permissions to each member of the organization

Field Type Required? Default Description Annotations
id string Yes -

organization io.flow.common.v0.unions.expandable_organization:0.7.56 Yes -

user io.flow.common.v0.unions.expandable_user:0.7.56 Yes -

role io.flow.common.v0.enums.role:0.7.56 No -

deprecated:

Static roles are being deprecated for role-based permissions.

personal_data

roles [io.flow.permission.v0.unions.flow_role:0.7.56] Yes -

The desired role(s) this user will play for the organization

personal_data

membership_form

Example Json: Minimal | Full

Top level resource to create a membership.

Field Type Required? Default Description Annotations
organization string Yes -

The id of the organization

user string Yes -

The id of the user to add to this organization

role io.flow.common.v0.enums.role:0.7.56 Yes member

deprecated:

Static roles are being deprecated for role-based permissions.

personal_data

roles [io.flow.permission.v0.unions.flow_role:0.7.56] Yes []

The desired role(s) this user will play for the organization

personal_data

membership_put_form

Example Json: Minimal | Full

Top level resource to update a membership.

Field Type Required? Default Description Annotations
role io.flow.common.v0.enums.role:0.7.56 Yes member

deprecated:

Static roles are being deprecated for role-based permissions.

personal_data

roles [io.flow.permission.v0.unions.flow_role:0.7.56] Yes []

The desired role(s) this user will play for the organization

personal_data

membership_version

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

timestamp date-time-iso8601 Yes -

type io.flow.common.v0.enums.change_type:0.7.56 Yes -

membership membership Yes -

organization_authorization

Example Json: Minimal | Full

Defines the data used for broad authorization of user access to org level data

Field Type Required? Default Description Annotations
role io.flow.common.v0.enums.role:0.7.56 No -

deprecated:

Static roles are being deprecated for role-based permissions.

personal_data

environment io.flow.common.v0.enums.environment:0.7.56 Yes -

organization_authorization_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
organization string Yes -

environment io.flow.common.v0.enums.environment:0.7.56 Yes -

organization_configuration_reference

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

organization_default_configurations

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

checkout_configuration organization_configuration_reference Yes -

organization_default_configurations_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

organization_form

Example Json: Minimal | Full

Either id or name is required.

Field Type Required? Default Description Annotations
id string No -

Defaults to a URL safe and unique version of the name

Minimum: 3

name string No -

Defaults to the id

Minimum: 3

environment io.flow.common.v0.enums.environment:0.7.56 Yes production

parent_id string No -

When creating an organization in the test environment, you must specify your production organization id.

defaults io.flow.common.v0.models.organization_defaults:0.7.56 No -

Used to override (if needed) the geolocation-based organization defaults

organization_put_form

Example Json: Minimal | Full

Data required to upsert an organization.

Field Type Required? Default Description Annotations
name string No -

Defaults to the id

Minimum: 3

environment io.flow.common.v0.enums.environment:0.7.56 No -

If updating, defaults to the current environment. If creating, defaults to production

parent_id string No -

When creating an organization in the test environment, you must specify your production organization id.

defaults io.flow.common.v0.models.organization_defaults:0.7.56 No -

Used to override (if needed) the geolocation-based organization defaults

organization_short_id

Example Json: Minimal | Full

A short identifier for an organization that is used to setup account IDs, invoice Prefixes, etc.

Field Type Required? Default Description Annotations
id string Yes -

organization io.flow.common.v0.models.organization_reference:0.7.56 Yes -

short_id string Yes -

organization_version

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

timestamp date-time-iso8601 Yes -

type io.flow.common.v0.enums.change_type:0.7.56 Yes -

organization io.flow.common.v0.models.organization:0.7.56 Yes -

region_setting

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
id string Yes -

region string Yes -

status io.flow.common.v0.enums.availability_status:0.7.56 Yes -

region_setting_form

Example Json: Minimal | Full
Field Type Required? Default Description Annotations
status io.flow.common.v0.enums.availability_status:0.7.56 Yes -

Unions

No unions

Annotations

personal_data

Identifies a field that contains Personal Data, as defined by GDPR. By default, any field marked with this annotation will be kept for 1 year and will be purgeable upon request provided there are no incomplete business activities associated with it.

consumer

Identifies a field that contains data about a consumer [as opposed to an employee of Flow, an organization or a partner].