API
⌘K
My Developer Account

IntegrationLink

A record linking another product's resource to a Check-Ins resource.

Example Request 

curl https://api.planningcenteronline.com/check-ins/v2/integration_links

View in API Explorer →

Example Object 

{
  "type": "IntegrationLink",
  "id": "1",
  "attributes": {
    "remote_app": "string",
    "remote_gid": "string",
    "remote_id": "string",
    "remote_type": "string",
    "sync_future_assignment_types": true
  },
  "relationships": {
    "local": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
id primary_key
remote_app string
remote_gid string

The Global ID for the external resource. Formatted as gid://<app>/<type>/<id>.
remote_id string
remote_type string
sync_future_assignment_types boolean

Relationships

Name Type Association Type Note
local Event to_one

Type will be the type of Check-Ins resource it is linked to.

Query By

Name Parameter Type Description Example
remote_gid where[remote_gid] string

Query on a specific remote_gid

 ?where[remote_gid]=string

Pagination

Name Parameter Type Description
per_page per_page integer

how many records to return per page (min=1, max=100, default=25)
offset offset integer

get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /check-ins/v2/integration_links

Reading

HTTP Method Endpoint
GET /check-ins/v2/integration_links/{id}

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/check-ins/v2/events/{event_id}/integration_links Event
GET https://api.planningcenteronline.com/check-ins/v2/check_ins/{check_in_id}/locations/{location_id}/integration_links Location
GET https://api.planningcenteronline.com/check-ins/v2/integration_links Organization