Get Entity Data

get

https://talk.perspio.io/organisation/v3/referencedata/{entityType}

Retrieve all data for a specific entity type. Any other query parameter whose name matches a property of the entity type (case-insensitive) is applied as an equality filter, e.g. ?branchName=Sydney; unknown or empty parameters are ignored. Without pageSize/continuationToken the full (filtered) list is returned as a bare array.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityType

string

enum

required

The entity type to retrieve data for

Allowed:

Query Params

pageSize

integer

Page size for paged mode (defaults to 100 when not a valid number). Supplying pageSize or continuationToken switches the response to the paged shape {"Data": [entities], "ContinuationToken": ""} instead of a bare array. Note: this operation uses camelCase pageSize, not the platform-wide page_size.

continuationToken

string

Continuation token from the previous paged response (Data/ContinuationToken shape). Also switches the response to paged mode.

Responses

400

Invalid Request

401

Invalid API Key provided or Invalid Access token

200Entity data

500Internal Server Error