Orgs API

An organization is a company or group of people that have access to the same resources and services.

List organizations

List all of the organizations the viewer has access to.

get
/ v1 / orgs 
curl --request GET \
     --url https://api.flexstack.com/v1/orgs \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Query Parameters

after
string

A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.

limit
integer (int64)

The maximum number of results to return. Must be between 1 and 240.

Responses

200
OK response.
data
array (object)
required

An array of results.

Show attributes
avatar
string

The avatar of the org.

created_at
string (date-time)
required

The time the org was created.

display_name
string
required

The display name of the org.

id
string
required

The ID of the org. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the org.

profile
object
required

Describes the profile of an org.

Show attributes
bio
string

The bio of the org.

github_handle
string

The GitHub handle of the org.

location
string

The location of the org.

twitter_handle
string

The Twitter handle of the org.

website
string

The website of the org.

updated_at
string (date-time)
required

The time the org was last updated.

has_more
boolean
required

Whether there are more results available.

next_page
string

The cursor for the next page of results as a base64 encoded string. Must match the pattern ^[a-zA-Z0-9+/=]+$.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Get feature flags

Get the feature flags for an organization.

get
/ v1 / flags 
curl --request GET \
     --url https://api.flexstack.com/v1/flags \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Responses

200
OK response.
flags
object
required

Describes the feature flags avaiable to an org.

Show attributes
chat_support
boolean
required

The chat support flag.

log_integrations
boolean
required

The log integrations flag.

max_concurrent_deployments
integer (int64)
required

The max concurrent deployments flag.

max_environments
integer (int64)
required

The max environments flag.

max_projects
integer (int64)
required

The max projects flag.

max_running_services
integer (int64)
required

The max running services flag.

max_team_member_invites
integer (int64)
required

The max team member invites flag.

max_team_members
integer (int64)
required

The max team members flag.

org_id
string
required

The ID of the org. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

List members

List all of the members of an organization.

get
/ v1 / members 
curl --request GET \
     --url https://api.flexstack.com/v1/members \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Query Parameters

role
array (string)

The role of the members to list.

after
string

A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.

limit
integer (int64)

The maximum number of results to return. Must be between 1 and 240.

sort_by
enum

A base64 encoded cursor that can be used to paginate results. One of created_at, -created_at, +created_at, created_at.

Responses

200
OK response.
data
array (object)
required

An array of results.

Show attributes
account_id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

avatar
string

The avatar of the member.

created_at
string (date-time)
required

The time the member was created.

display_name
string
required

The display name of the member.

id
string
required

The ID of the membership. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

org_id
string
required

The organization ID. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

profile
object
required

Describes the profile of an org.

Show attributes
bio
string

The bio of the org.

github_handle
string

The GitHub handle of the org.

location
string

The location of the org.

twitter_handle
string

The Twitter handle of the org.

website
string

The website of the org.

role
enum
required

The role of the member within the org. One of owner, admin, member.

has_more
boolean
required

Whether there are more results available.

next_page
string

The cursor for the next page of results as a base64 encoded string. Must match the pattern ^[a-zA-Z0-9+/=]+$.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Get an organization

Get an organization by ID.

get
/ v1 / orgs / :id 
curl --request GET \
     --url https://api.flexstack.com/v1/orgs/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The organization ID to look up. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Responses

200
OK response.
avatar
string

The avatar of the org.

created_at
string (date-time)
required

The time the org was created.

display_name
string
required

The display name of the org.

id
string
required

The ID of the org. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the org.

profile
object
required

Describes the profile of an org.

Show attributes
bio
string

The bio of the org.

github_handle
string

The GitHub handle of the org.

location
string

The location of the org.

twitter_handle
string

The Twitter handle of the org.

website
string

The website of the org.

updated_at
string (date-time)
required

The time the org was last updated.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Update an organization

Update an organization.

put
/ v1 / orgs / :id 
curl --request PUT \
     --url https://api.flexstack.com/v1/orgs/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

id
string
required

The ID of the org to update. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Request Body

Important note

PUT requests are used to replace an existing resource. The request body should contain the full representation of the resource, including any fields that are not being updated.

display_name
string
required

The display name of the org. Must match the pattern ^[a-zA-Z0-9-_]+$.

name
string
required

The name of the org.

profile
object
required

Describes the profile of an org.

Show attributes
bio
string

The bio of the org.

github_handle
string

The GitHub handle of the org.

location
string

The location of the org.

twitter_handle
string

The Twitter handle of the org.

website
string

The website of the org.

Responses

200
OK response.
avatar
string

The avatar of the org.

created_at
string (date-time)
required

The time the org was created.

display_name
string
required

The display name of the org.

id
string
required

The ID of the org. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the org.

profile
object
required

Describes the profile of an org.

Show attributes
bio
string

The bio of the org.

github_handle
string

The GitHub handle of the org.

location
string

The location of the org.

twitter_handle
string

The Twitter handle of the org.

website
string

The website of the org.

updated_at
string (date-time)
required

The time the org was last updated.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Check feature flag

Check if the current org is able to use a feature.

get
/ v1 / flags / :flag 
curl --request GET \
     --url https://api.flexstack.com/v1/flags/notification_webhooks \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

flag
enum
required

The feature flag to check. One of max_running_services, max_environments, max_projects, max_team_members, max_team_member_invites, max_concurrent_deployments, notification_integrations, notification_webhooks, log_integrations, chat_support.

Responses

200
OK response.
ok
boolean
required

Whether the org can use the feature.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Get a member

Get a member of an organization by ID.

get
/ v1 / members / :id 
curl --request GET \
     --url https://api.flexstack.com/v1/members/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The member ID to look up. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Responses

200
OK response.
account_id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

avatar
string

The avatar of the member.

created_at
string (date-time)
required

The time the member was created.

display_name
string
required

The display name of the member.

id
string
required

The ID of the membership. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

org_id
string
required

The organization ID. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

profile
object
required

Describes the profile of an org.

Show attributes
bio
string

The bio of the org.

github_handle
string

The GitHub handle of the org.

location
string

The location of the org.

twitter_handle
string

The Twitter handle of the org.

website
string

The website of the org.

role
enum
required

The role of the member within the org. One of owner, admin, member.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Update a member

Update a member of an organization.

put
/ v1 / members / :id 
curl --request PUT \
     --url https://api.flexstack.com/v1/members/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

id
string
required

The member ID to look up. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Request Body

Important note

PUT requests are used to replace an existing resource. The request body should contain the full representation of the resource, including any fields that are not being updated.

role
enum

The role of the member within the org. One of owner, admin, member.

Responses

200
OK response.
account_id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

avatar
string

The avatar of the member.

created_at
string (date-time)
required

The time the member was created.

display_name
string
required

The display name of the member.

id
string
required

The ID of the membership. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

org_id
string
required

The organization ID. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

profile
object
required

Describes the profile of an org.

Show attributes
bio
string

The bio of the org.

github_handle
string

The GitHub handle of the org.

location
string

The location of the org.

twitter_handle
string

The Twitter handle of the org.

website
string

The website of the org.

role
enum
required

The role of the member within the org. One of owner, admin, member.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Delete a member

Delete a member of an organization.

delete
/ v1 / members / :id 
curl --request DELETE \
     --url https://api.flexstack.com/v1/members/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The member ID to look up. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Responses

204
No content
400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

List member invites

List all of the invites to an organization.

get
/ v1 / member-invites 
curl --request GET \
     --url https://api.flexstack.com/v1/member-invites \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Query Parameters

role
array (string)

The role of the invites to list.

after
string

A base64 encoded cursor that can be used to paginate results. Must match the pattern ^[\w-+/=]+$.

limit
integer (int64)

The maximum number of results to return. Must be between 1 and 240.

sort_by
enum

A base64 encoded cursor that can be used to paginate results. One of created_at, -created_at, +created_at, created_at, expires_at, -expires_at, +expires_at, expires_at.

Responses

200
OK response.
data
array (object)
required

An array of results.

Show attributes
created_at
string (date-time)
required

The time the invite was created.

email
string

The email of the invitee.

expires_at
string (date-time)
required

The time the invite expires.

id
string
required

The ID of the invite. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

invited_by
object

Describes the member that invited an invitee.

Show attributes
avatar
string

The avatar of the member.

display_name
string
required

The display name of the member.

id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

org_id
string
required

The ID of the org that the invite is for. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

role
enum
required

The role that the invitee will have. One of owner, admin, member.

has_more
boolean
required

Whether there are more results available.

next_page
string

The cursor for the next page of results as a base64 encoded string. Must match the pattern ^[a-zA-Z0-9+/=]+$.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Invite members

Invite members to an organization.

post
/ v1 / member-invites 
curl --request POST \
     --url https://api.flexstack.com/v1/member-invites \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Request Body

invitees
array (object)

The emails to invite with their roles. If omitted, an invite link will be generated. Must contain at most 25 items.

Show attributes
email
string (email)
required

The email of the invitee.

role
enum
required

The role of the invitee. One of owner, admin, member.

Responses

201
Created response.
created_at
string (date-time)
required

The time the invite was created.

email
string

The email of the invitee.

expires_at
string (date-time)
required

The time the invite expires.

id
string
required

The ID of the invite. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

invited_by
object

Describes the member that invited an invitee.

Show attributes
avatar
string

The avatar of the member.

display_name
string
required

The display name of the member.

id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

link
string

The link to accept the invite.

org_id
string
required

The ID of the org that the invite is for. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

role
enum
required

The role that the invitee will have. One of owner, admin, member.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Get a member invite

Get an invite to an organization by ID.

get
/ v1 / member-invites / :id 
curl --request GET \
     --url https://api.flexstack.com/v1/member-invites/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The invite ID to look up. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Responses

200
OK response.
created_at
string (date-time)
required

The time the invite was created.

email
string

The email of the invitee.

expires_at
string (date-time)
required

The time the invite expires.

id
string
required

The ID of the invite. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

invited_by
object

Describes the member that invited an invitee.

Show attributes
avatar
string

The avatar of the member.

display_name
string
required

The display name of the member.

id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

org_id
string
required

The ID of the org that the invite is for. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

role
enum
required

The role that the invitee will have. One of owner, admin, member.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Update a member invite

Update an invite to an organization.

put
/ v1 / member-invites / :id 
curl --request PUT \
     --url https://api.flexstack.com/v1/member-invites/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl' \
     --header 'content-type: application/json'

Path Parameters

id
string
required

The invite ID to look up. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Request Body

Important note

PUT requests are used to replace an existing resource. The request body should contain the full representation of the resource, including any fields that are not being updated.

role
enum
required

The role of the invite. One of owner, admin, member.

Responses

200
OK response.
created_at
string (date-time)
required

The time the invite was created.

email
string

The email of the invitee.

expires_at
string (date-time)
required

The time the invite expires.

id
string
required

The ID of the invite. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

invited_by
object

Describes the member that invited an invitee.

Show attributes
avatar
string

The avatar of the member.

display_name
string
required

The display name of the member.

id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

org_id
string
required

The ID of the org that the invite is for. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

role
enum
required

The role that the invitee will have. One of owner, admin, member.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Delete a member invite

Delete an invite to an organization.

delete
/ v1 / member-invites / :id 
curl --request DELETE \
     --url https://api.flexstack.com/v1/member-invites/1C8xJnvSBaztoHyxcim7C4 \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The invite ID to look up. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Responses

204
No content
400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

Resend a member invite

Resend an invite to an organization.

post
/ v1 / member-invites / :id / resend 
curl --request POST \
     --url https://api.flexstack.com/v1/member-invites/1C8xJnvSBaztoHyxcim7C4/resend \
     --header 'accept: application/json' \
     --header 'x-api-key: flex_018bcaea5d6a7678a1d0c9f70e72cd0el4csZ5Etx8BwFZ8QJ9YEwl'

Path Parameters

id
string
required

The invite ID to resend. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

Responses

201
Created response.
created_at
string (date-time)
required

The time the invite was created.

email
string

The email of the invitee.

expires_at
string (date-time)
required

The time the invite expires.

id
string
required

The ID of the invite. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

invited_by
object

Describes the member that invited an invitee.

Show attributes
avatar
string

The avatar of the member.

display_name
string
required

The display name of the member.

id
string
required

The account ID of the member. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

name
string
required

The name of the member.

org_id
string
required

The ID of the org that the invite is for. Must match the pattern (^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$)|(^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)|(^[0-9a-f]{32}$).

role
enum
required

The role that the invitee will have. One of owner, admin, member.

400
Bad Request response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

401
Unauthorized response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

403
Forbidden response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

404
Not Found response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

408
Request Timeout response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

409
Conflict response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

429
Too Many Requests response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

500
Internal Server Error response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

501
Not Implemented response.
cause
unknown

The cause of the error.

code
enum
required

The code of the error. One of bad_input, forbidden, unauthenticated, unauthorized, not_implemented, internal, not_found, conflict, timeout, rate.

message
string
required

The message of the error.

API Reference

Explore the API reference by resource type

Post to