Get integrations

Get integrations

GET 
undefined/functions/v1/integrations

Get integrations

Request

Query Parameters

search string

The search term to filter the templates

page string

The number of the page to get the templates

pageSize string

The number of templates per page

Header Parameters

X-Organization-Id string

The ID of the organization (this parameter is not required when using API key authorization)

X-Project-Id uuid

The ID of the project to create the integration (Use this if you are not going to use the X-Project-Name)

X-Project-Name string

The Name of the project to create the integration (Use this if you are not going to use the X-Project-Id)

Responses

200

Success

application/json

Schema

Schema

successboolean
Default value: true
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 200
statusTextstring
Default value: Success
messagestring
Default value: Message successfully
Example: Gets integrations success
localizationstring
Default value: someone-method:success
Example: get-integrations:success
pagination object
pagesnumber
Default value: 2
pagenumber
Default value: 1
sizenumber
Default value: 25
totalnumber
Default value: 50
data object[]
Array [
namestring
Default value: integration name
Example: my workspace
providerNamestring
Example: provider name
workspaceTypeenum
Possible values: [organization, personal]
Example: organization
iduuid
Example: 595fcf9b-c57a-4ad0-81a5-556fbd6b1240
projectIduuid
Example: 595fcf9b-c57a-4ad0-81a5-556fbd6b1240
providerData object
urlstring
Example: https://example-url.com/provider
logostring
Example: https://example-url.com/images/logo.png
namestring
Example: myuser
nodeIdstring
Example: abcdefghijklmnopqrstuvwxyz
reposUrlstring
Example: https://example-url.com/provider/abcxyz/repos
descriptionstring
Example: my description
createdAtstring
Example: 2025-01-01T00:00:00.000Z
expiredAtstring
Example: 2025-01-01T00:00:00.000Z
workspacestring
Example: my workspace
]

Example (auto)

{
  "success": true,
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 200,
  "statusText": "Success",
  "message": "Gets integrations success",
  "localization": "get-integrations:success",
  "pagination": {
    "pages": 2,
    "page": 1,
    "size": 25,
    "total": 50
  },
  "data": [
    {
      "name": "my workspace",
      "providerName": "provider name",
      "workspaceType": "organization",
      "id": "595fcf9b-c57a-4ad0-81a5-556fbd6b1240",
      "projectId": "595fcf9b-c57a-4ad0-81a5-556fbd6b1240",
      "providerData": {
        "url": "https://example-url.com/provider",
        "logo": "https://example-url.com/images/logo.png",
        "name": "myuser",
        "nodeId": "abcdefghijklmnopqrstuvwxyz",
        "reposUrl": "https://example-url.com/provider/abcxyz/repos",
        "description": "my description"
      },
      "createdAt": "2025-01-01T00:00:00.000Z",
      "expiredAt": "2025-01-01T00:00:00.000Z",
      "workspace": "my workspace"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 400
statusTextstring
Default value: Bad Request
messagestring
Default value: Message Error
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 400,
  "statusText": "Bad Request",
  "message": "Message Error",
  "localization": "someone-method:error"
}

404

Not Found

application/json

Schema

Schema

successboolean
Default value: false
dataobject
Default value: null
timestampstring
Default value: 2024-01-01T00:00:00.000Z
statusCodenumber
Default value: 404
statusTextstring
Default value: Not Found
messagestring
Default value: Message Not Found
localizationstring
Default value: someone-method:error

Example (auto)

{
  "success": false,
  "data": {},
  "timestamp": "2024-01-01T00:00:00.000Z",
  "statusCode": 404,
  "statusText": "Not Found",
  "message": "Message Not Found",
  "localization": "someone-method:error"
}

Authorization: x-api-key

name: x-api-keytype: apiKeyin: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "undefined/functions/v1/integrations");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("x-api-key", "<x-api-key>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

undefined/functions/v1

Auth

apiKeyAuth

Parameters

search — query

page — query

pageSize — query

X-Organization-Id — header

X-Project-Id — header

X-Project-Name — header

ResponseClear

Click the Send API Request button above and see the response here!