Boomi MFT - AFT Management API Reference (v1) - Organization

Toggle Pane

• Organization
  • getRetrieves a specific organization configuration by ID
  • delDeletes an organization configuration
  • getRetrieves a list of all organizations
  • putUpdates an existing organization configuration
  • postCreates a new organization configuration
  • getRetrieves recent activity for organizations

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Organization

Retrieves a specific organization configuration by ID

Returns complete organization configuration including status, codes, and metadata.

Authorizations:

ApiKeyBearer

path Parameters

id required

integer <int32> The unique identifier of the organization

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
tenantId	integer <int32>
name	string or null
organizationStatusId	integer <int32>
publicCode	string or null
description	string or null
tags	string or null

https://us.thruinc.com/api/Organization/{id}

https://uk.thruinc.com/api/Organization/{id}

https://eu.thruinc.com/api/Organization/{id}

https://au.thruinc.com/api/Organization/{id}

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Deletes an organization configuration

Removes organization configuration and marks it as deleted.

Authorizations:

ApiKeyBearer

path Parameters

id required

integer <int32> The unique identifier of the organization to delete

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

	object (thruStatus)
data	any or null

https://us.thruinc.com/api/Organization/{id}

https://uk.thruinc.com/api/Organization/{id}

https://eu.thruinc.com/api/Organization/{id}

https://au.thruinc.com/api/Organization/{id}

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves a list of all organizations

Returns list of all organizations with optional inclusion of deleted organizations.

Authorizations:

ApiKeyBearer

query Parameters

showDeleted

boolean Default: false Whether to include deleted organizations in the results (default: false)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
tenantId	integer <int32>
name	string or null
organizationTypeId	integer <int32>
organizationStatusId	integer <int32>
publicCode	string or null
systemCode	string or null
description	string or null
secretKey	string or null
createdBy	string or null
createdDate	string or null <date-time>
updatedBy	string or null
updatedDate	string or null <date-time>
deletedBy	string or null
deletedDate	string or null <date-time>

https://us.thruinc.com/api/Organization

https://uk.thruinc.com/api/Organization

https://eu.thruinc.com/api/Organization

https://au.thruinc.com/api/Organization

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Updates an existing organization configuration

Modifies existing organization configuration including name and status.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Organization view model with updated configuration settings

id	integer <int32>
tenantId	integer <int32>
name	string or null
organizationStatusId	integer <int32>
publicCode	string or null
description	string or null
tags	string or null

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

id	integer <int32>
tenantId	integer <int32>
name	string or null
organizationStatusId	integer <int32>
publicCode	string or null
description	string or null
tags	string or null

https://us.thruinc.com/api/Organization

https://uk.thruinc.com/api/Organization

https://eu.thruinc.com/api/Organization

https://au.thruinc.com/api/Organization

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "tenantId": 0,
• "name": "string",
• "organizationStatusId": 0,
• "publicCode": "string",
• "description": "string",
• "tags": "string"

}

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Creates a new organization configuration

Establishes new organization with specified configuration and metadata.

Authorizations:

ApiKeyBearer

Request Body schema:

application/jsontext/jsonapplication/*+jsonapplication/json

Complete organization model with configuration settings for the new organization

id	integer <int32>
tenantId	integer <int32>
name	string or null
organizationStatusId	integer <int32>
publicCode	string or null
description	string or null
tags	string or null

Responses

https://us.thruinc.com/api/Organization

https://uk.thruinc.com/api/Organization

https://eu.thruinc.com/api/Organization

https://au.thruinc.com/api/Organization

Request samples

• Payload

Content type

application/jsontext/jsonapplication/*+jsonapplication/json

{

• "id": 0,
• "tenantId": 0,
• "name": "string",
• "organizationStatusId": 0,
• "publicCode": "string",
• "description": "string",
• "tags": "string"

}

Response samples

• 201
• 400
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample

Retrieves recent activity for organizations

Returns recent organization activity including creation and modification timestamps.

Authorizations:

ApiKeyBearer

query Parameters

count required

integer <int32> Number of recent activity records to retrieve (required)

Responses

Response Schema:

text/plainapplication/jsontext/jsontext/plain

Array

id	integer <int32>
name	string or null
systemCode	string or null
createdDate	string <date-time>
updatedDate	string or null <date-time>

https://us.thruinc.com/api/Organization/getRecentOrganizationActivity

https://uk.thruinc.com/api/Organization/getRecentOrganizationActivity

https://eu.thruinc.com/api/Organization/getRecentOrganizationActivity

https://au.thruinc.com/api/Organization/getRecentOrganizationActivity

Response samples

• 200
• 401
• 403
• 500

Content type

text/plainapplication/jsontext/jsontext/plain

No sample