List all entities with pagination - Flow

GET

/

project

/

{projectId}

/

entities

List all entities with pagination

curl --request GET \
  --url https://backend.branch.flowengineering.com/project/{projectId}/entities \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>'

import requests

url = "https://backend.branch.flowengineering.com/project/{projectId}/entities"

headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};

fetch('https://backend.branch.flowengineering.com/project/{projectId}/entities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "formulaTemplates": {},
      "formulas": {},
      "id": "<string>",
      "links": {
        "crosslinks": [
          "<string>"
        ],
        "inbound": [
          "<string>"
        ],
        "inboundOrder": {},
        "outbound": [
          "<string>"
        ],
        "inboundTypes": {},
        "outboundOrder": {},
        "outboundTypes": {},
        "rootPlaced": true
      },
      "values": {},
      "branchesChangedIn": [
        "<string>"
      ],
      "branchesCreatedIn": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "defaultSortKey": "<string>",
      "deleted": true,
      "type": "<string>",
      "uniqueEntityNumber": 123,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "moreAvailable": true,
  "nextPageStart": "<string>"
}

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Path Parameters

projectId

string

required

Query Parameters

branch_id

string

entity_type

string

starting_after

string

Keyset cursor. Start a walk with starting_after=0, then pass each response's nextPageStart for the next page, continuing while moreAvailable is true. This is the preferred way to walk entities — O(limit) per page at any depth and skip-free. When set, offset is ignored.

offset

number

Legacy offset pagination, available only below 1000. Cost grows with the offset and, under heavy deletes, a page can come up short and skip entities — prefer starting_after.

limit

number

Page size, at most 1000. Larger values receive a 400 Bad Request response.

Response

200 - application/json

items

object[]

required

Show child attributes

moreAvailable

boolean

Whether more pages may exist (keyset mode only). Keep paginating while true.

nextPageStart

string

Cursor to pass as starting_after for the next page (keyset mode only). Opaque; compare only for equality.

List all entities with pagination

curl --request GET \
  --url https://backend.branch.flowengineering.com/project/{projectId}/entities \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>'

import requests

url = "https://backend.branch.flowengineering.com/project/{projectId}/entities"

headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {customer: '<customer>', 'X-API-Key': '<api-key>'}};

fetch('https://backend.branch.flowengineering.com/project/{projectId}/entities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "formulaTemplates": {},
      "formulas": {},
      "id": "<string>",
      "links": {
        "crosslinks": [
          "<string>"
        ],
        "inbound": [
          "<string>"
        ],
        "inboundOrder": {},
        "outbound": [
          "<string>"
        ],
        "inboundTypes": {},
        "outboundOrder": {},
        "outboundTypes": {},
        "rootPlaced": true
      },
      "values": {},
      "branchesChangedIn": [
        "<string>"
      ],
      "branchesCreatedIn": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "defaultSortKey": "<string>",
      "deleted": true,
      "type": "<string>",
      "uniqueEntityNumber": 123,
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "moreAvailable": true,
  "nextPageStart": "<string>"
}