Cap Collectif Developers - GraphQL API

Overview
Schema Previews Breaking Changes
Query
Mutations
Preview addEvent Preview changeEvent Preview deleteAccountByEmail Preview deleteEvent
Objects
Preview Argument Preview CollectStep Public Consultation Preview ConsultationStep Preview DistrictTranslation Preview Event Preview EventTranslation Preview GlobalDistrict Preview GoogleMapsAddress Preview MajorityQuestion Preview Media Preview MediaQuestion Preview MediaResponse Preview MultipleChoiceQuestion Preview OfficialResponse Preview Opinion Public PageInfo Preview Post Preview PostTranslation Public Project Preview ProjectDistrictPositioner Preview ProjectType Preview Proposal Preview ProposalAnalysis Preview ProposalAssessment Preview ProposalCategory Preview ProposalDecision Preview ProposalSelection Preview ProposalStepStatus Preview ProposalVote Preview QuestionChoice Public Questionnaire Preview QuestionnaireStep Preview RemainingTime Preview SectionQuestion Preview SelectionStep Preview SimpleQuestion Preview Source Preview Theme Preview TimeRange Public User Public UserError Preview UserReply Preview ValueResponse Preview Version
Interfaces
Preview Author Preview District Public Draftable Public Node Preview PrivatableVote Public Publishable Preview Question Preview Response Preview Step Public Trashable Public UniformResourceLocatable Preview Vote Public Vote
Enums
Preview ContributionOrderField Preview DeleteAccountByEmailErrorCode Preview EventOrderField Preview GoogleMapsAddressType Public NotPublishedReason Public OrderDirection Preview ProjectOrderField Preview ProposalAnalysisState Preview ProposalOrderField Preview ProposalStepStatusColor Preview ProposalVoteOrderField Public StepAdminUrlOperationType Preview StepState Public TrashableStatus
Input Objects
Preview AddEventInput Preview ChangeEventInput Preview ContributionOrder Preview DeleteAccountByEmailInput Preview DeleteEventInput Preview EventOrder Preview EventTranslationInput Preview ProjectOrder Preview ProposalOrder Preview ProposalVoteOrder
Scalars
Public Boolean Public CssJSON Public DateTime Public Email Public Float Public GeoJSON Public HTML Public ID Public IP Public Int Public JSON Public String Public URI

Query

The query type defines GraphQL operations that retrieve data from the server.

Connections

events (EventConnection!)

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see Schema previews for more details.

Lookup events.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

first Int

Returns the first n elements from the list.

The default value is 100.

orderBy EventOrder

Ordering options for events returning from the connection.

The default value is { "field": "START_AT", "direction": "DESC" }.

project ID

ID of a Project to filter by. If non-null, only events belonging to the project will be returned.

globalDistricts (GlobalDistrictConnection!)

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see Schema previews for more details.

List all the district project in the platform.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

first Int

Returns the first n elements from the list.

The default value is 100.

name String

Filter by name.

The default value is null.

projects (ProjectConnection!)

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see Schema previews for more details.

Lookup projects.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

first Int

Returns the first n elements from the list.

The default value is 100.

orderBy ProjectOrder

Ordering options for projects returning from the connection.

The default value is { "field": "PUBLISHED_AT", "direction": "DESC" }.

theme ID

ID of a Theme to filter by. If non-null, filter projects by themes

users (UserConnection!)

This part of the schema is currently available for developers to preview. During this preview period, the API may change without any advance notice. Please see Schema previews for more details.

Lookup users.

Argument Type Description
after String

Returns the elements in the list that come after the specified cursor.

first Int

Returns the first n elements from the list.

The default value is 100.

Fields

node (Node)

Lookup a node by its ID.

Argument Type Description
id ID!

The ID of an object.

nodes ([Node]!)

Lookup nodes by a list of IDs.

Argument Type Description
ids [ID!]!

The list of node IDs.

viewer (User!) ROLE_USER

The currently authenticated user.