Facebook Developers
DocsToolsSupportNewsApps
Log In
  • Social Plugins
  • Facebook Login
  • Open Graph
  • Facebook APIs
    • Graph API
    • FQL
    • Open Graph
    • Dialogs
    • Chat
    • Internationalization
    • Ads
  • Games
  • Payments
  • App Center
  • Promote Your App
  • iOS
  • Android
  • JavaScript
  • PHP
  • More SDKs
  • Objects
    • Achievement(Instance)
    • Album
    • App and Game Groups
    • Application
    • Checkin
    • Comment
    • Domain
    • Errors
    • Event
    • Field Expansion
    • FriendList
    • Group
    • Insights
    • Link
    • Message
    • Note
    • Offer
    • Order
    • Page
    • Pagination
    • Payment
    • Photo
    • Pictures
    • Post
    • Privacy Parameter
    • Publishing
    • Question
    • QuestionOption
    • Realtime Updates
    • Review
    • Search
    • Selecting Results
    • Status message
    • Thread
    • User
    • Video

Checkin

Facebook APIs › Graph API › Checkin

Publishing a Checkin object is deprecated in favor of creating a Post with a location attached.

A Checkin represents a single visit to a location. The User and Page objects have checkin connections.

The behavior of Checkins is affected by the "Include Checkins with Statuses" migration setting.

To read Checkins with this migration enabled, you need:

  • user_status permission to read the user's checkins.
  • friends_status permission to read the user's friend's checkins.

To read Checkins without this migration enabled, you need:

  • the user_checkins permission to read the user's checkins.
  • the friends_checkins permission to read the user's friend's checkins.

To read a Checkin object, issue an HTTP GET request to /CHECKIN_ID with one of the above permissions.


Fields

NameDescriptionPermissionsReturns
id

The checkin ID

user_checkins

string

from

The ID and name of the user who made the checkin

user_checkins

object containing the id and name fields

tags

The users the author tagged in the checkin

user_checkins

array of objects containing the id and name fields

place

Information about the Facebook Page that represents the location of the checkin

user_checkins

object containing the Page id, name, and location; location includes the specific latitude and longitude along with information about the postal addresses, if available

application

Information about the application that made the checkin

user_checkins

object that contains the name and id, canvas_name, and namespace of the application

created_time

The time the checkin was created

user_checkins

string containing ISO-8601 date-time datetime

likes

Users who like the checkin

user_checkins

array of objects containing id and name fields

message

The message the user added to the checkin

user_checkins

string

comments

All of the comments on this link

user_checkins

Array of objects containing id, from, message and created_time fields

type

The type of this object; always returns checkin

user_checkins

string


Connections

NameDescriptionPermissionsReturns
comments

All of the comments on this checkin.

user_checkins or friends_checkins as appropriate

array of objects containing id, from, message and created_time fields.

likes

Users who like this checkin.

user_checkins or friends_checkins as appropriate

array of objects containing the id and name fields.

comments

Create

You can write to the CHECKIN_ID/comments connection to post a comment to the checkin by issuing an HTTP POST request with the publish_stream permission and following parameters.

Parameter Description Type Required
message Comment text string yes

If the write is successful, you get the following return.

Name Description Type
id The new comment ID string

likes

Create

You can like a checkin by issuing a HTTP POST request to CHECKIN_ID/likes connection with the publish_stream permission. No parameters are necessary.

If the write is successful, you get the following return.

Description Type
If the like succeeded boolean

Delete

You can unlike an checkin by issuing an HTTP DELETE request to the CHECKIN_ID/likes connection with the publish_stream permission.

If the delete is successful, you get the following return.

Description Type
If the unlike succeeded boolean
Updated on Thursday
Facebook © 2013 · English (US)
AboutAdvertisingCareersPlatform PoliciesPrivacy Policy