Graph API Version

Event

Represents an Event.

Limitations

Access to Events on Users and Pages is only available to Facebook Marketing Partners.

Reading

Get fields and edges on an Event.

Requirements

For Events on an App:

  • An App access token of an App that created the Event.

For Events on a Group:

  • A User access token of an Admin of the Event.
  • The Groups API feature.

Example

Graph API Explorer
GET /v9.0/{event-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{event-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{event-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{event-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{event-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The event ID

attending_count
int32

Number of people attending the event

can_guests_invite
bool

Can guests invite friends. Requires an access token of an Admin of the Event

category
enum {ART_EVENT, BOOK_EVENT, MOVIE_EVENT, FUNDRAISER, VOLUNTEERING, FAMILY_EVENT, FESTIVAL_EVENT, NEIGHBORHOOD, RELIGIOUS_EVENT, SHOPPING, COMEDY_EVENT, MUSIC_EVENT, DANCE_EVENT, NIGHTLIFE, THEATER_EVENT, DINING_EVENT, FOOD_TASTING, CONFERENCE_EVENT, MEETUP, CLASS_EVENT, LECTURE, WORKSHOP, FITNESS, SPORTS_EVENT, OTHER}

The category of the event

cover

Cover picture

declined_count
int32

Number of people who declined the event

description
string

Long-form description

discount_code_enabled
bool

Is discount code enabled for this event

end_time
string

End time, if one has been set

event_times
list<ChildEvent>

Array of times of a multi-instance event

guest_list_enabled
bool

Can see guest list. Requires an access token of an Admin of the Event

interested_count
int32

Number of people interested in the event

is_canceled
bool

Whether or not the event has been marked as canceled

is_draft
bool

Whether the event is in draft mode or published. Requires an access token of an Admin of the Event

is_online
bool

Whether the event is online or not. Required to pass the 'address' (city name) parameter for online events.

is_page_owned
bool

Whether the event is created by page or not

maybe_count
int32

Number of people who maybe going to the event

name
string

Event name

noreply_count
int32

Number of people who did not reply to the event

online_event_format
enum {messenger_room, third_party, fb_live, other, none}

Type of online event - Live, Link or Other

online_event_third_party_url
string

Third party streaming url associated with Link events

owner

The profile that created the event

parent_group

The group the event belongs to

place

Event Place information

scheduled_publish_time
string

Time when event is scheduled to be published

start_time
string

Start time

ticket_uri
string

The link users can visit to buy a ticket to this event

ticket_uri_start_sales_time
string

Time when tickets go on sale

ticketing_privacy_uri
string

URI to seller's privacy policy for ticket purchases

ticketing_terms_uri
string

URI to seller's terms of service for ticket purchases

timezone
enum

Timezone

type
enum {private, public, group, community, friends}

The type of the event

updated_time
datetime

Last update time (ISO 8601 formatted)

Edges

EdgeDescription

List of profiles having roles on the event. Requires an access token of an Admin of the Event

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter
368The action attempted has been deemed abusive or is otherwise disallowed
459The session is invalid because the user has been checkpointed

Creating

You can make a POST request to events edge from the following paths:
When posting to this edge, an Event will be created.

Requirements

  • A User access token of an Admin of the Group.
  • The Groups API feature.

Parameters

ParameterDescription
description
UTF-8 string

Description of the event

Supports Emoji
end_time
time

End time of the event in ISO format

location
UTF-8 encoded string

Location of the Event

name

Name of the event

RequiredSupports Emoji
start_time
time

Start time of the event in ISO format, can omit time and only include date information

Required

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Validation Rules

ErrorDescription
1000Invalid time for an event.
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.