Organizations

Organization management endpoints

get

GET /api/v1/org/all

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/org/all
get

GET /api/v1/org/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/org/{id}
delete

DELETE /api/v1/org/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/org/{id}
get

GET /api/v1/org/{id}/teams

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/org/{id}/teams
get

GET /api/v1/org/{id}/orgs

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/org/{id}/orgs
get

GET /api/v1/org/name/{name}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
namestringRequired

Path parameter: name

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/org/name/{name}
post

POST /api/v1/org/

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
post
/api/v1/org/
post

POST /api/v1/org/update/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/org/update/{id}
get

GET /api/v1/billing/payment-methods/org/{orgId}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
orgIdstringRequired

Path parameter: orgId

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/billing/payment-methods/org/{orgId}
get

GET /api/v1/stripe/payment-methods/org/{orgId}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
orgIdstringRequired

Path parameter: orgId

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/stripe/payment-methods/org/{orgId}
get

GET /payment-methods/org/{orgId}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

Path parameters
orgIdstringRequired

Path parameter: orgId

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/payment-methods/org/{orgId}

Last updated