Cap Collectif Developers - GraphQL API

Thank you for your interest in our public API !

This is an early release… We will progressively enhance the documentation (including more examples !) and complete what can be retrieved via the public API, throughout the following weeks. Thank you in advance for your patience and do not hesitate to return regularly to this documentation to see its evolution.

Please notice, you do not need an API key to read public data.

The technical team of Cap Collectif.

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.

author ID

If non-null, filters events with the given author.

before String

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

first Int

Returns the first `n` elements from the list.

isFuture Boolean

If non-null, filters events by comparing the start date with present.

last Int

Returns the last `n` elements from the list.

project ID

If non-null, filters events with the given project.

search String

If non-null, filters events with the given string to look for.

theme ID

If non-null, filters events with the given theme.

userType ID

If non-null, filters events with the given author type.

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.

author ID

If non-null, filter projects by author

before String

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

first Int

Returns the first `n` elements from the list.

last Int

Returns the last `n` elements from the list.

onlyPublic Boolean

If true, return only publics projects

orderBy ProjectOrder

Ordering options for projects returning from the connection.

status ID

If non-null, filter projects by statuses.

term String

If non-null, projects with the given string to look for.

theme ID

If non-null, filter projects by themes

type ID

If non-null, filter projects by types

withEventOnly Boolean

If true, filter projects with events

Fields

node (Node)

The ID of an object.

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

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.

The currently authenticated user.