list_entities
GET
/entitiesAuthorizationBearer <token>
A service principal's credential, or a person's access token, AgentFlow's own or an installed app's. A service principal's effective permissions are its role permissions intersected with the credential's scopes.
In: header
Query Parameters
include_archived?boolean
Include archived entities.
limit?integer
Page size.
Format
int32Range
1 <= value <= 200cursor?string
Forward cursor, from next_cursor.
before?string
Backward cursor, from prev_cursor.
sort?"name"
The order of the list; name when absent.
Value in
- "name"
dir?string
asc or desc; ascending when absent.
Value in
- "asc"
- "desc"
q?string
A substring of the entity's name or key, ignoring case.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/entities"{ "items": [ { "accent": "string", "access_mode": "everyone", "actions": [ { "icon": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "input_map": [ { "from": "string", "to": "string" } ], "key": "string", "label": "string", "mode": "async", "scope": "row", "tone": null, "visible_when": null, "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe" } ], "archived_at": "2019-08-24T14:15:22Z", "browsable": true, "browser_config": { "base_filter": null, "browsable_view_ids": [ "3421736a-6226-4801-b7ee-ae38811dd6e5" ], "create_form": null, "default_detail_view_id": "5a89240a-4553-41a2-98ae-3236540e2355", "default_sort": null, "default_view_id": "b9b79666-6a53-4965-8110-5b321a17e0a6", "detail_view_ids": [ "f6842dc3-7d1d-4772-aa42-13ebaeaf012f" ], "display_field": "string", "facets": [ { "field": "string", "order": 0, "ranges": [ { "from": 0, "key": "string", "to": 0, "window": null } ] } ], "owner_source_field": "string", "primary_date_field": "string", "stage_model": null, "view_order": [ "082817c2-2fbe-4145-a642-a84b8194523f" ] }, "comment_config": null, "created_at": "2019-08-24T14:15:22Z", "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4", "description": "string", "fields": [ { "auto_number_format": "string", "auto_number_scope": "string", "chartable": true, "constraints": null, "declares_relationship": true, "default": null, "description": "string", "enum_values": [ { "color": "string", "label": "string", "value": "string" } ], "facetable": true, "filterable": true, "format": null, "format_options": {}, "formula_expression": "string", "formula_result_type": null, "index_state": "none", "inverse_key": "string", "inverse_label": "string", "item_fields": [ { "enum_values": [ { "color": "string", "label": "string", "value": "string" } ], "history": true, "key": "string", "label": "string", "mentions": true, "required": true, "type": "text" } ], "key": "string", "label": "string", "on_target_delete": null, "ratio_of": null, "read_only": true, "reference_filter": [ { "field": "string", "op": "eq", "value": null } ], "relationship_key": "string", "required": true, "rollup": null, "searchable": true, "sensitive": true, "sortable": true, "system": true, "target_entity_id": "dae9646c-1cdc-42fb-8650-576539f0343f", "type": "text" } ], "formula_recompute_stalled": true, "formula_recomputing": true, "icon": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "is_system": true, "key": "string", "key_builds_stalled": [ "string" ], "name": "string", "natural_key": [ { "build_token": "8f6ec0ec-fe16-4d65-8dbc-93c0279faae3", "conflict": null, "fields": [ "string" ], "id": "string", "name": "string", "state": "active" } ], "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "requires_unit_classification": true, "updated_at": "2019-08-24T14:15:22Z", "version": 0, "work_config": null, "bulk_hidden_action_ids": [ "4870151b-2654-486d-aaf4-e5dc08d32eff" ], "effective_capabilities": { "delete": true, "design": true, "list": true, "read": true, "write": true }, "field_access": { "property1": { "create": true, "read": true, "update": true }, "property2": { "create": true, "read": true, "update": true } } } ], "next_cursor": "string", "prev_cursor": "string"}