Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-138386226.8 KB
Parties

Get parties by pj

Retrieve a paginated and sorted collection of parties associated with the specified project (using its pj_code), or a subset thereof based on a specified search query.

get/projects/{pj_code}/parties

Path parameters

pj_codestring required

Query parameters

searchstring

Search term used for full-text record retrieval

sort'default' | '+default' | '-default' | 'surname' | '+surname' | '-surname' | 'organization_name' | '+organization_name' | '-organization_name' | 'obs_count' | '+obs_count' | '-obs_count'

Sort order for results. Prefix with - for descending order or + for ascending order. Ascending order is the default if no prefix is provided.

Available sort fields:

  • default - Default sort order
  • surname - Sort by surname
  • organization_name - Sort by organization name
  • obs_count - Sort by observation count

Examples:

  • sort=surname - Sort by surname ascending
  • sort=-obs_count - Sort by observation count descending
  • sort=+organization_name - Sort by organization name ascending (explicit)
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 party or parties

py_codestring

VegBank party identifier

party_labelstring

Name/label for the party

salutationstring

Salutation used in addressing an individual with a particular title

given_namestring

All names, except the surname, of the individual associated with the resource. Possible usages include: first name and middle name, first name and middle initials, first name, etc.

middle_namestring

Middle name or initial, if any

surnamestring

Name shared in common to identify the members of a family, as distinguished the given name

organization_namestring

Full name of the organization, which may be the party itself if this is an organization-type party record, or else is the organization that the party is associated with if this is a person-type party record

contact_instructionsstring

Instructions for contacting a party

obs_countinteger

Number of plot observations associated with this entity

Example response

{
  "py_code": "py.1",
  "party_label": "NatureServe (organization)",
  "salutation": "Dr.",
  "given_name": "Jo R.",
  "middle_name": "R.",
  "surname": "Smith",
  "organization_name": "NatureServe",
  "contact_instructions": "contact the contributor at specified email",
  "obs_count": 17
}