Skip to main content
GET
Get a party

Path Parameters

partyId
string<uuid>
required

The party's id.

Response

The party's profile and record.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
name
string
required
description
string | null
required

Written by the party's leader.

leaderUsername
string
required

The public username of the citizen who leads the party.

registeredAt
string<date-time>
required

ISO 8601 timestamp, UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
listed
boolean
required

Whether the party appears in the registry's default list. An unlisted party is still reachable at its own address.

moderation
enum<string>
required

The party's moderation standing. Only cleared parties are in the default list; the others are returned when includeUnlisted is set.

Available options:
clear,
in_review,
flagged_as_spam
url
string<uri>
required

The party's page in the app.

websiteUrl
string | null
required
color
string | null
required

The leader's chosen color as #rrggbb, or null for the default.

updatedAt
string<date-time>
required

ISO 8601 timestamp, UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
dissolvedAt
string<date-time> | null
required

ISO 8601 timestamp, UTC.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
subsidiesAllocated
number | null
required

WDD allocated to the party in party subsidies, across all elections; each allocation is released over 365 days. Null where the allocations could not be read.

electionRecord
object[]
required

The party's results in closed test elections.