Organizations

Organization (entity/account) management operations

List all organizations

get

Returns all organizations accessible to the authenticated user

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses

200

List of organizations

application/json

idintegerRequired

Unique organization identifier

Example: 1

namestringRequired

Organization name

Example: Acme Corporation

typestring · enumRequired

Organization type

Example: customerPossible values:

statusstring · enumRequired

Organization status

Example: activePossible values:

industrystring · nullableOptional

Industry category

Example: Technology

websitestring · nullableOptional

Organization website URL

Example: https://acme.example.com

descriptionstring · nullableOptional

Organization description

metadataobject · nullableOptional

Additional organization metadata

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Access denied

500

Server error

get/organizations

GET /api/organizations HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "name": "Acme Corporation",
    "type": "customer",
    "status": "active",
    "industry": "Technology",
    "website": "https://acme.example.com",
    "description": "text",
    "metadata": {},
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Create a new organization

post

Creates a new organization. Requires consultant or admin role.

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body

namestringRequired

Organization name

Example: New Client Inc.

typestring · enumRequiredPossible values:

statusstring · enumRequiredDefault: activePossible values:

industrystring · nullableOptional

websitestring · nullableOptional

descriptionstring · nullableOptional

metadataobject · nullableOptional

Responses

200

Organization created successfully

application/json

idintegerRequired

Unique organization identifier

Example: 1

namestringRequired

Organization name

Example: Acme Corporation

typestring · enumRequired

Organization type

Example: customerPossible values:

statusstring · enumRequired

Organization status

Example: activePossible values:

industrystring · nullableOptional

Industry category

Example: Technology

websitestring · nullableOptional

Organization website URL

Example: https://acme.example.com

descriptionstring · nullableOptional

Organization description

metadataobject · nullableOptional

Additional organization metadata

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

400

Validation error

401

Not authenticated

403

Permission denied

500

Server error

post/organizations

POST /api/organizations HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "name": "New Client Inc.",
  "type": "customer",
  "status": "active",
  "industry": "text",
  "website": "text",
  "description": "text",
  "metadata": {}
}

{
  "id": 1,
  "name": "Acme Corporation",
  "type": "customer",
  "status": "active",
  "industry": "Technology",
  "website": "https://acme.example.com",
  "description": "text",
  "metadata": {},
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get an organization

get

Returns a specific organization by ID

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Organization ID

Responses

200

Organization details

application/json

idintegerRequired

Unique organization identifier

Example: 1

namestringRequired

Organization name

Example: Acme Corporation

typestring · enumRequired

Organization type

Example: customerPossible values:

statusstring · enumRequired

Organization status

Example: activePossible values:

industrystring · nullableOptional

Industry category

Example: Technology

websitestring · nullableOptional

Organization website URL

Example: https://acme.example.com

descriptionstring · nullableOptional

Organization description

metadataobject · nullableOptional

Additional organization metadata

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Access denied

404

Organization not found

500

Server error

get/organizations/{id}

GET /api/organizations/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "name": "Acme Corporation",
  "type": "customer",
  "status": "active",
  "industry": "Technology",
  "website": "https://acme.example.com",
  "description": "text",
  "metadata": {},
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Update an organization

put

Updates an existing organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Organization ID

Body

namestringOptional

typestring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

industrystring · nullableOptional

websitestring · nullableOptional

descriptionstring · nullableOptional

metadataobject · nullableOptional

Responses

200

Organization updated successfully

application/json

idintegerRequired

Unique organization identifier

Example: 1

namestringRequired

Organization name

Example: Acme Corporation

typestring · enumRequired

Organization type

Example: customerPossible values:

statusstring · enumRequired

Organization status

Example: activePossible values:

industrystring · nullableOptional

Industry category

Example: Technology

websitestring · nullableOptional

Organization website URL

Example: https://acme.example.com

descriptionstring · nullableOptional

Organization description

metadataobject · nullableOptional

Additional organization metadata

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Permission denied

404

Organization not found

500

Server error

put/organizations/{id}

PUT /api/organizations/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "name": "text",
  "type": "customer",
  "status": "active",
  "industry": "text",
  "website": "text",
  "description": "text",
  "metadata": {}
}

{
  "id": 1,
  "name": "Acme Corporation",
  "type": "customer",
  "status": "active",
  "industry": "Technology",
  "website": "https://acme.example.com",
  "description": "text",
  "metadata": {},
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Delete an organization

delete

Deletes an organization. Requires consultant or admin role.

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Organization ID

Responses

204

Organization deleted successfully

No content

400

Cannot delete organization with related items

401

Not authenticated

403

Permission denied

404

Organization not found

500

Server error

delete/organizations/{id}

DELETE /api/organizations/{id} HTTP/1.1
Accept: */*

No content

Duplicate an organization

post

Creates a copy of an existing organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

idintegerRequired

Organization ID to duplicate

Responses

200

Organization duplicated successfully

application/json

idintegerRequired

Unique organization identifier

Example: 1

namestringRequired

Organization name

Example: Acme Corporation

typestring · enumRequired

Organization type

Example: customerPossible values:

statusstring · enumRequired

Organization status

Example: activePossible values:

industrystring · nullableOptional

Industry category

Example: Technology

websitestring · nullableOptional

Organization website URL

Example: https://acme.example.com

descriptionstring · nullableOptional

Organization description

metadataobject · nullableOptional

Additional organization metadata

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

401

Not authenticated

403

Permission denied

404

Organization not found

500

Server error

post/organizations/{id}/duplicate

POST /api/organizations/{id}/duplicate HTTP/1.1
Accept: */*

{
  "id": 1,
  "name": "Acme Corporation",
  "type": "customer",
  "status": "active",
  "industry": "Technology",
  "website": "https://acme.example.com",
  "description": "text",
  "metadata": {},
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

List tasks for an organization

get

Returns all tasks associated with a specific organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

organizationIdintegerRequired

Organization ID

Responses

200

List of organization tasks

application/json

object[]Optional

401

Not authenticated

403

Access denied

500

Server error

get/organizations/{organizationId}/tasks

GET /api/organizations/{organizationId}/tasks HTTP/1.1
Accept: */*

[
  {}
]

List projects for an organization

get

Returns all projects associated with a specific organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

organizationIdintegerRequired

Organization ID

Responses

200

List of organization projects

application/json

object[]Optional

401

Not authenticated

403

Access denied

500

Server error

get/organizations/{organizationId}/projects

GET /api/organizations/{organizationId}/projects HTTP/1.1
Accept: */*

[
  {}
]

List documents for an organization

get

Returns all documents associated with a specific organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

organizationIdintegerRequired

Organization ID

Responses

200

List of organization documents

application/json

object[]Optional

401

Not authenticated

403

Access denied

500

Server error

get/organizations/{organizationId}/documents

GET /api/organizations/{organizationId}/documents HTTP/1.1
Accept: */*

[
  {}
]

List members of an organization

get

Returns all contact members of a specific organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

organizationIdintegerRequired

Organization ID

Responses

200

List of organization members

application/json

organizationIdintegerOptional

contactIdintegerOptional

rolestring · enumOptionalPossible values:

401

Not authenticated

500

Server error

get/organizations/{organizationId}/members

GET /api/organizations/{organizationId}/members HTTP/1.1
Accept: */*

[
  {
    "organizationId": 1,
    "contactId": 1,
    "role": "primary",
    "contact": {
      "id": 1,
      "fullName": "text",
      "email": "text",
      "title": "text"
    }
  }
]

Add a member to an organization

post

Associates a contact with an organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

organizationIdintegerRequired

Organization ID

Body

contactIdintegerRequired

Contact ID to add

rolestring · enumRequired

Member role

Possible values:

Responses

200

Member added successfully

No content

401

Not authenticated

403

Permission denied

500

Server error

post/organizations/{organizationId}/members

POST /api/organizations/{organizationId}/members HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "contactId": 1,
  "role": "primary"
}

No content

Remove a member from an organization

delete

Removes the association between a contact and an organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

organizationIdintegerRequired

Organization ID

contactIdintegerRequired

Contact ID

Responses

204

Member removed successfully

No content

401

Not authenticated

403

Permission denied

404

Member not found

500

Server error

delete/organizations/{organizationId}/members/{contactId}

DELETE /api/organizations/{organizationId}/members/{contactId} HTTP/1.1
Accept: */*

No content

Update an organization member

patch

Updates a member's role in the organization

Authorizations

connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters

organizationIdintegerRequired

Organization ID

contactIdintegerRequired

Contact ID

Body

rolestring · enumOptionalPossible values:

Responses

200

Member updated successfully

No content

401

Not authenticated

403

Permission denied

404

Member not found

500

Server error

patch/organizations/{organizationId}/members/{contactId}

PATCH /api/organizations/{organizationId}/members/{contactId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "role": "primary"
}

No content