organization

Get Many Organizations

Get Many Organizations

Securitybearer
Request
query Parameters
select
Array of strings

Select Organization fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "name" "description" "address" "orgNumber" "invoiceAddress" "invoiceEmail" "companyVAT"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Organizations. (e.g. limit=20)

offset
integer

Offset amount of received Organizations. (e.g. offset=20)

object

Sort received Organizations by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/organization
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": { }
}

Create One Organization

Create One Organization

Securitybearer
Request
Request Body schema: application/json
required
name
required
string
description
string
address
string
orgNumber
string
invoiceAddress
string
invoiceEmail
string
companyVAT
string
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/organization
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "address": "string",
  • "orgNumber": "string",
  • "invoiceAddress": "string",
  • "invoiceEmail": "string",
  • "companyVAT": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Organization

Get One Organization

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Organization fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "name" "description" "address" "orgNumber" "invoiceAddress" "invoiceEmail" "companyVAT"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/organization/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}

Update One Organization

Update One Organization

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
description
string
address
string
orgNumber
string
invoiceAddress
string
invoiceEmail
string
companyVAT
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/organization/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "address": "string",
  • "orgNumber": "string",
  • "invoiceAddress": "string",
  • "invoiceEmail": "string",
  • "companyVAT": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Organization

Replace One Organization

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
description
string
address
string
orgNumber
string
invoiceAddress
string
invoiceEmail
string
companyVAT
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/organization/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "address": "string",
  • "orgNumber": "string",
  • "invoiceAddress": "string",
  • "invoiceEmail": "string",
  • "companyVAT": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Organization

Delete One Organization

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/organization/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to custom-field