Skip to main content
GET
/
v2.0
/
functions
/
{functionId}
/
instances
Get Function Instances
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/functions/{functionId}/instances \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "_id": "<string>",
      "trigger": "flow",
      "status": "active",
      "error": "<string>",
      "createdAt": 1694518620,
      "finishedAt": 1694518620
    }
  ],
  "total": 1,
  "nextCursor": "<string>",
  "previousCursor": "<string>"
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
functionId
string
required

The Id of the Function

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Query Parameters

ā€‹
projectId
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
limit
integer

The maximum number of items to return. Use this parameter to control page size. The default value is 25, and the maximum permitted value is 100.

Required range: 1 <= x <= 100
ā€‹
skip
integer

The number of items to skip before returning the results. Use this parameter with limit for offset-based pagination. The default value is 0.

Required range: x >= 0
ā€‹
sort
string

The order in which results are returned. Set a sorting rule in the format field:direction, where direction can be asc for ascending order or desc for descending order. For example, name:asc sorts by name in ascending order.

Minimum string length: 1
ā€‹
next
string

The cursor that points to the next page of results. Use the nextCursor value returned in a previous response to request the next set of items.

Required string length: 24
ā€‹
previous
string

The cursor that points to the previous page of results. Use the previousCursor value returned in a previous response to request the previous set of items.

Required string length: 24

Response

Returns an array of Function Instance metadata objects

ā€‹
items
object[]
ā€‹
total
integer
Example:

1

ā€‹
nextCursor
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
previousCursor
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$