NCnceas
Parties

Get all roles

Changed on

Retrieve a paginated collection of all roles recorded in VegBank.

get/roles

Request

Query parameters

searchstring

Search term used for full-text record retrieval

limitinteger

Maximum number of records to return

offsetinteger

Number of records to skip before starting to return records

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching role or roles

ar_codestring

VegBank role identifier

namestring

Role name/label

descriptionstring

Role description

Example response

{
  "ar_code": "ar.56",
  "name": "Data aggregator",
  "description": "Person who aggregates and directs data from one place or platform to another"
}

Changes