API Reference

List all entities in a Project

get
https://go.v7labs.com/api/workspaces//projects//entities

Returns details of entities in a given Project

Note: project_id is the same as agent_id

Path Params
uuid
required
uuid
required
Query Params
uuid
active_view_ids
array of uuids | null
Defaults to
deprecated
Common.UUIDList
uuid
only_property_ids
array of uuids | null

List of property IDs to include in the response. If provided, only fields matching these property IDs will be included.

Common.OnlyPropertyIds
integer | null
1 to 5120

Maximum bytes for field values. If set, values larger than this will be truncated with partial: true indicator.

boolean
order_by
array of strings | null

List of property slugs/ids to order by

Projects.ListEntities.ListEntitiesOrderBy
order_directions
array of strings | null

List of order directions for the fields in order_by

Pagination.OrderDirections
integer | null
≥ 0

The maximum number of records to return when using offset pagination

integer | null
≥ 0

The offset to use when paginating records

integer | null

The number of records to return after the provided cursor; used in combination with after

integer | null

The number of records to return for before the provided cursor; used in combination with before

string | null

A base64 encoded value representing a cursor, or an element ID if applicable

string | null

A base64 encoded value representing a cursor, or an element ID if applicable

Responses

Callback

Updated about 2 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 2 months ago