> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flextell.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# List the tenant's integration connections
## OpenAPI
````yaml get /v1/integration-connections
openapi: 3.1.0
info:
title: Flextell API
version: 0.0.1
description: >-
Flextell REST API referansı. Kimlik doğrulama, scope ve istek kuralları için
API sekmesindeki rehberlere bakın.
servers:
- url: https://app.flextell.ai/api
description: Üretim
security:
- oauth2: []
- bearer: []
paths:
/v1/integration-connections:
get:
tags:
- IntegrationConnection
summary: List the tenant's integration connections
operationId: integration-connections.index
parameters:
- name: integration_id
in: query
description: Filter by catalogue integration ID.
schema:
type:
- integer
- 'null'
minimum: 1
- name: entity
in: query
description: Filter by the record type the connection writes (lead).
schema:
anyOf:
- $ref: '#/components/schemas/IntegrationEntity'
- type: 'null'
- name: status
in: query
description: >-
Filter by status (draft, active, paused).
| |
|---|
| `draft`
Created but never activated; received records wait
for the field mapping. |
| `active`
|
| `paused`
Records are still accepted and stored, but not
processed until the connection is activated again. |
schema:
anyOf:
- $ref: '#/components/schemas/IntegrationConnectionStatus'
- type: 'null'
- name: created_at_from
in: query
description: Filter connections created on or after this date.
schema:
type:
- string
- 'null'
format: date-time
- name: created_at_to
in: query
description: Filter connections created on or before this date.
schema:
type:
- string
- 'null'
format: date-time
- name: sort_by
in: query
description: The field to sort by.
schema:
type:
- string
- 'null'
enum:
- created_at
- name
- last_received_at
- null
- name: sort_order
in: query
description: The sort direction (asc or desc).
schema:
type:
- string
- 'null'
enum:
- asc
- desc
- null
- name: per_page
in: query
description: The number of items per page.
schema:
type:
- integer
- 'null'
minimum: 1
maximum: 100
- name: page
in: query
description: The page number.
schema:
type:
- integer
- 'null'
minimum: 1
- name: X-Tenant
in: header
required: true
description: >-
Tenant identifier. Send the Tenant ID in the `X-Tenant` header to
scope API requests to a specific tenant.
schema:
type: number
responses:
'200':
description: Paginated set of `IntegrationConnectionResource`
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/IntegrationConnectionResource'
links:
type: object
properties:
first:
type:
- string
- 'null'
last:
type:
- string
- 'null'
prev:
type:
- string
- 'null'
next:
type:
- string
- 'null'
required:
- first
- last
- prev
- next
meta:
type: object
properties:
current_page:
type: integer
minimum: 1
from:
type:
- integer
- 'null'
minimum: 1
last_page:
type: integer
minimum: 1
links:
type: array
description: Generated paginator links.
items:
type: object
properties:
url:
type:
- string
- 'null'
label:
type: string
active:
type: boolean
required:
- url
- label
- active
path:
type:
- string
- 'null'
description: Base path for paginator generated URLs.
per_page:
type: integer
description: Number of items shown per page.
minimum: 0
to:
type:
- integer
- 'null'
description: Number of the last item in the slice.
minimum: 1
total:
type: integer
description: Total number of items being paginated.
minimum: 0
required:
- current_page
- from
- last_page
- links
- path
- per_page
- to
- total
required:
- data
- links
- meta
'401':
$ref: '#/components/responses/AuthenticationException'
'403':
$ref: '#/components/responses/AuthorizationException'
'422':
$ref: '#/components/responses/ValidationException'
components:
schemas:
IntegrationEntity:
type: string
description: |
The Flextell record type a connection writes into.
enum:
- lead
title: IntegrationEntity
IntegrationConnectionStatus:
type: string
description: >-
| |
|---|
| `draft`
Created but never activated; received records wait for
the field mapping. |
| `active`
|
| `paused`
Records are still accepted and stored, but not
processed until the connection is activated again. |
enum:
- draft
- active
- paused
title: IntegrationConnectionStatus
IntegrationConnectionResource:
type: object
properties:
id:
type: integer
name:
type: string
integration:
$ref: '#/components/schemas/RelatedIntegrationResource'
entity:
type: object
description: The record type the connection writes.
properties:
value:
type: string
label:
type: string
required:
- value
- label
status:
type: string
description: >-
`draft` until first activated, `active`, or `paused`. Records are
stored in every status but only
processed while active.
inbound_url:
type: string
description: The URL the provider posts records to.
secret:
type:
- string
- 'null'
description: >-
The value the provider must send in the secret header; `null` unless
the caller may update the connection.
secret_header:
type: string
description: The header carrying the secret.
const: X-Flextell-Secret
field_mapping:
type: array
items:
type: object
properties:
source:
type: string
target:
type: string
required:
- source
- target
external_id_path:
type:
- string
- 'null'
settings:
type: object
description: >-
Entity-specific options, keyed as listed by the integration-entities
endpoint.
additionalProperties: {}
stats:
type: object
description: Received records per processing status.
properties:
pending:
type: integer
processed:
type: integer
failed:
type: integer
skipped:
type: integer
required:
- pending
- processed
- failed
- skipped
last_received_at:
type:
- string
- 'null'
format: date-time
last_processed_at:
type:
- string
- 'null'
format: date-time
created_at:
type:
- string
- 'null'
format: date-time
updated_at:
type:
- string
- 'null'
format: date-time
required:
- id
- name
- integration
- entity
- status
- inbound_url
- secret
- secret_header
- field_mapping
- external_id_path
- settings
- stats
- last_received_at
- last_processed_at
- created_at
- updated_at
title: IntegrationConnectionResource
RelatedIntegrationResource:
type: object
properties:
id:
type: integer
name:
type: string
system_name:
type:
- string
- 'null'
company_logo:
type: 'null'
description: >-
Short-lived (5 minute) signed URL of the integrator logo; `null`
when none is set.
required:
- id
- name
- system_name
- company_logo
title: RelatedIntegrationResource
responses:
AuthenticationException:
description: Unauthenticated
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error overview.
required:
- message
AuthorizationException:
description: Authorization error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Error overview.
required:
- message
ValidationException:
description: Validation error
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: Errors overview.
errors:
type: object
description: A detailed description of each field that failed validation.
additionalProperties:
type: array
items:
type: string
required:
- message
- errors
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://dev.flextell.ai/oauth/authorize
tokenUrl: https://dev.flextell.ai/oauth/token
scopes:
'*': all
bearer:
type: http
scheme: bearer
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.