> ## Documentation Index
> Fetch the complete documentation index at: https://sendcloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a list of integrations

> Retrieve all valid integrations from the Sendcloud system for a given user.



## OpenAPI

````yaml /.openapi/v3/integrations/openapi.yaml get /integrations
openapi: 3.1.0
info:
  title: Integrations
  version: 3.0.0
  contact:
    name: Sendcloud API Support
    email: contact@sendcloud.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: >-
    The Integrations API lets you manage some aspects of your integrations, and
    set and retrieve available shop order statuses.
servers:
  - url: https://panel.sendcloud.sc/api/v3
    description: Sendcloud Production
security: []
tags:
  - name: Integrations
    description: IntegrationsAPI
  - name: Exception logs
    description: Integration exception logs API
paths:
  /integrations:
    get:
      tags:
        - Integrations
      summary: Retrieve a list of integrations
      description: >-
        Retrieve all valid integrations from the Sendcloud system for a given
        user.
      operationId: sc-public-v3-integrations-get-list_integrations
      parameters:
        - in: query
          name: sort
          schema:
            type: string
          description: >
            Set the order for the response items:

            - Sorting is supported by the `integration_type`, `created_at`,
            `updated_at`, `last_fetch`, and `failing_since` attributes in the
            response object.

            - To sort the response in descending order, add the prefix `-` to
            the query param value.

            - By default, the items will be ordered by `last_fetch` and then
            `created_at`.
          example: updated_at
      responses:
        '200':
          description: All valid integrations from the Sendcloud System for a given user.
          content:
            application/json:
              schema:
                title: Integration List Response
                type: object
                description: >-
                  Integration object as represented in the response of the list
                  request.
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/integration-response-model'
              examples:
                Response:
                  value:
                    data:
                      - id: 23452345
                        shop_name: 'Integration #1'
                        shop_url: https://www.my-shop-integration.com/
                        type: api
                        started_failing_at: '2023-11-10T16:16:42Z'
                        last_fetched_at: '2023-11-10T16:15:09Z'
                        created_at: '2023-11-04T14:15:22Z'
                        updated_at: '2023-11-08T12:23:56Z'
                        service_point_enabled: true
                        service_point_carriers:
                          - ups
                          - dhl
                        webhook_active: true
                        webhook_url: >-
                          https://my-shop-integration.integrator/api/webhooks/sendcloud
                        feedback_type: eager
      security:
        - HTTPBasicAuth: []
components:
  schemas:
    integration-response-model:
      title: Integration Response Object
      type: object
      description: Integration object.
      allOf:
        - $ref: '#/components/schemas/integration-model'
        - type: object
          properties:
            id:
              type: integer
              description: ID of an integration.
              example: 23452345
            type:
              type: string
              description: >-
                Type of shop/system the integration connects to. In Integrations
                API V2, this attribute was referred to as `system`.
              example: api
            started_failing_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                Timestamp from when the integration is failing to fetch orders
                or to send feedback. This value will be in the [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
                In the Integrations API V2, this attribute was referred to as
                `failing_since`.
              example: '2023-11-10T16:16:42Z'
            last_fetched_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                The last time we managed to fetch data from this integration,
                used for rate limiting purposes. This value will be in the
                [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
                In the Integrations API V2, this attribute was referred to as
                `last_fetch`.
              example: '2023-11-10T16:15:09Z'
            created_at:
              type: string
              format: date-time
              description: >-
                Timestamp when the integration was created. This value will be
                in the [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
              example: '2023-11-04T14:15:22Z'
            updated_at:
              type: string
              format: date-time
              description: >-
                Timestamp when the integration was last updated. This value will
                be in the [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
              example: '2023-11-08T12:23:56Z'
    integration-model:
      title: Integration Object
      type: object
      description: Integration object.
      properties:
        shop_name:
          type: string
          title: Shop Name
          maxLength: 250
          minLength: 1
          description: Name of the shop.
          example: My Shop Integration
        shop_url:
          type: string
          title: Shop url
          description: URL of the shop the integration connects to.
          format: uri
          minLength: 1
          example: https://www.my-shop-integration.com/
        service_point_enabled:
          type: boolean
          title: Service point enabled
          description: Flag indicating if delivery to service points is enabled.
          example: false
        service_point_carriers:
          type: array
          title: Service point carriers
          description: >-
            List of carriers available for the service point picker. If service
            point delivery is enabled, make sure to provide at least one
            carrier.
          items:
            type: string
            example: ups
          example:
            - ups
            - dhl
        webhook_active:
          type: boolean
          title: Webhook active
          description: Flag indicating if parcel updates should be sent via the webhook.
          example: false
        webhook_url:
          type:
            - string
            - 'null'
          title: Webhook url
          format: uri
          description: >-
            URL for sending updates on a parcel. A value for `webhook_url` is
            required if `webhook_active` is set to `true`.
          minLength: 1
          example: https://my-shop-integration.integrator/api/webhooks/sendcloud
        feedback_type:
          type: string
          title: Feedback Type
          enum:
            - eager
            - delayed
            - none
          description: >-
            Define how your shop status feedback should be sent into your
            system. 

            Note that this will not apply to Prestashop V2 as the custom status
            mapping will define this.  

            Use the following states:
               - eager: Change the parcels’ status to “sent” once the label is created.
               - delayed: Change the parcels’ status to “sent” once the carrier scans the label.
               - none: Don’t send any feedback.
          minLength: 1
  securitySchemes:
    HTTPBasicAuth:
      type: http
      description: >-
        Basic Authentication using API key and secrets is currently the main
        authentication mechanism.
      scheme: basic

````