v1

latestOpenAPI 3.0.02026-07-243678114.1 KB

Integrations

Get All Integrations

The Get All Integrations endpoint allows you to retrieve a list of all integrations available within your organization. Use this endpoint to review and manage the integrations that connect BoomFi with other platforms.

get/v1/integrations

Response

created_atstring

The timestamp indicating when the integration was created.

created_bystring

The user or entity that created the integration.

descriptionstring

The description of the integration.

enabledboolean

Indicates whether the integration is enabled.

idinteger

The unique identifier of the integration.

last_errorstring

The last error message encountered during synchronization.

last_sync_timestring

The timestamp indicating when the last synchronization occurred.

namestring

The name of the integration.

org_idstring

The identifier of the organization associated with the integration.

propertiesobject

Additional properties associated with the integration.

schemaobject

The schema of the integration.

status1 | 2 | 3 | 4 | 5

The current status of the organization integration:

1 = Unknown
2 = Updating
3 = Ready
4 = Disabling
5 = Disabled

template_namestring

The template name of the integration.

type1 | 2 | 3 | 4 | 5

The integration type of the organization:

1 = TypeUnknown
2 = TypeBilling
3 = TypeEcommerce
4 = TypeAccounting
5 = TypeWorkflow

updated_atstring

The timestamp indicating when the integration was last updated.

Example response

[
  {
    "created_at": "2023-01-01T12:00:00Z",
    "created_by": "user123",
    "description": "Integration for data synchronization",
    "enabled": true,
    "id": 123456,
    "last_error": "Connection timeout",
    "last_sync_time": "2023-01-02T08:30:00Z",
    "name": "Data Sync",
    "org_id": "org123",
    "template_name": "Data Sync Template",
    "updated_at": "2023-01-03T10:45:00Z"
  }
]