Cap Collectif Developers - GraphQL API

Connections Fields

Preview addEvent Preview changeEvent Preview deleteAccountByEmail Preview deleteEvent

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

Overview

Cap Collectif provides an API to read and write data.

Endpoint

This is an HTTPS-only and POST-only API. All API requests are made to https://demo-api.cap-collectif.com/graphql.

Authentication

Authentication is based on API Keys. Each API Key is associated with a user. Results returned from various responses are based upon the role of the user to which the API key is tied.

ROLE_USER indicates that this field can only be access if authenticated.
ROLE_ADMIN indicates that this field can only be access if authenticated as an administrator.

Your API Keys

Right now, you can't generate an API Key. Contact our API team if needed.

How to use an API Key

To make an authenticated query, add an Authorization header with content "Bearer token". Example using cURL :


    curl -H "Content-Type: application/json" -H "Authorization: Bearer token" -X POST -d '{"query":"query viewer {\n  viewer {\n    id\n    username\n  }\n}"}' https://demo-api.cap-collectif.com/graphql

Rate limits

We currently have no rate limits, but this might be coming soon.

About the GraphQL schema reference

The docs in the sidebar are generated from our GraphQL schema. All calls are validated and executed against the schema. Use these docs to find out what data you can call:

Allowed operations: queries and mutations.
Schema-defined types: scalars, objects, enums, interfaces, unions, and input objects.

You can access this same content via the Explorer Docs sidebar. Note that you may need to rely on both the docs and the schema validation to successfully call the GraphQL API. For other information, such as authentication and rate limit details, check out the guides.

Requesting support

For questions, bug reports, and discussions about API development contact our API team.