Get deployments API endpoint enables you to retrieve all deployments associated with your app. To use this API, you will need to include the unique app_key
of your app as a query parameter and your api_key
in the request header to authenticate the request.
In this article, we will provide examples of HTTP and cURL code samples, along with information on the response status codes and response fields that you can expect.
Get deployments
GET https://app.integry.io/partners/api/bundle/
Returns a JSON object with an array containing all deployments.
Required parameters
- Query parameters: Add the unique
app_key
of your app - Headers: Add your
api_key
to the request header to authenticate the request.
Please note that
app_key
should be the same as used in the SDK embed.Code samples
HTTP
GET https://app.integry.io/partners/api/bundle/?app_key=<your_app_key> api-key: <your_api_key>
cURL
curl --request GET 'https://app.integry.io/partners/api/bundle/?app_key=<your_app_key>' \ --header 'api-key: <your_api-key>'
HTTP response status codes
200
: Returned if the call is successful400
: Returned in case of invalid app_key
403
: Returned in case of invalid authentication parameters (api_key
)500
: Returned in case of an internal server errorSample response
[ { "id": 71, "title": null, "name": "Drop One", "description": "This is the demo of drop one apps", "icon_url": "https://storage.googleapis.com/app-services-prod--bucket/public/d50b86d9-5d00-4eeb-8e68-9dbc19bfc9a3.png", "color": "#ac3737", "bundle_type": "SDK", "status": 1, "created_on": "2019-04-08T15:55:02.016215Z", "updated_on": "2023-01-24T11:46:35.364746Z", "top_menu_color": null, "link_color": null, "footer_color": null, "header_color": null, "background_color": null, "url": null, "logo_url": "https://storage.googleapis.com/app-services-prod--bucket/public/4ea99144-a4e8-4d83-9874-f27f9f6a95ab.png", "bundle_mode": null, "wizard_step": null, "locked_by": null, "signin_method": "NONE", "signin_connector_id": null, }, ... }
Response fields
id
: The ID of the deployment.title
: The title of the deployment.name
: The name of the deployment.description
: A short description of the deployment.icon_url
: The URL for the deployment's icon image.color
: The color of the deployment, specified in hex format.bundle_type
: The type of bundle used for the deployment. Options include:"APPDIR"
: Marketplace deployment"SDK"
: SDK Deployment
created_on
: The date and time the deployment was created.updated_on
: The date and time the deployment was last updated.top_menu_color
: The color of the top menu for the deployment, specified in hex format.link_color
: The color of links within the deployment, specified in hex format.footer_color
: The color of the footer for the deployment, specified in hex format.header_color
: The color of the header for the deployment, specified in hex format.background_color
: The background color for the deployment, specified in hex format.url
: The URL for the deployment.logo_url
: The URL for the deployment's logo image.signin_method
: The sign-in method for the deployment. Options include:"SSO"
"CONNECTOR_AUTH"
"NONE"
signin_connector_id
: The ID of the sign-in connector for the deployment.
Comments
0 comments
Please sign in to leave a comment.