Skip to content

Commit

Permalink
Clarify only internal events returned by authenticated REST API endpo…
Browse files Browse the repository at this point in the history
…ints (#156)
  • Loading branch information
lavaturtle authored Sep 2, 2024
1 parent c76e694 commit 646a404
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion source/includes/authenticated_api/_events.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Events represent real-world or virtual meetings that members can RSVP to. RSVP records are called "attendees".

The authenticated REST API endpoints for events only deal with events created in ControlShift, whether through the web or the API. Events imported from another system (such as Mobilize America or EveryAction/VAN) are not included.

### List

> GET response body
Expand Down Expand Up @@ -68,7 +70,9 @@ Events represent real-world or virtual meetings that members can RSVP to. RSVP r
}
```

Returns a paginated list of all events, including ones that are unlaunched or otherwise not visible to the public. Includes all the same data as the single-event endpoint for each event.
Returns a paginated list of all events, including ones that are unlaunched or otherwise not visible to the public. External events are not included.

The response includes all the same data as the single-event endpoint for each event.

<%= partial "includes/shared/pagination.md" %>

Expand Down

0 comments on commit 646a404

Please sign in to comment.