Okapi Okapi

Onesignal GET /api/v1/players/{id} endpoint removal

Deprecated, no dateSubscribe to OnesignalShare

Onesignal has deprecated the GET /api/v1/players/{id} endpoint without a shutdown date. Requests sent to this legacy endpoint will eventually fail. Onesignal characterizes this as a legacy route and points developers to alternative user-level options.


Calls it hits

  • GET /api/v1/players/{id}

What to use instead of these calls

Switch calls to the View User endpoint using the path GET apps/{app_id}/users/by/{alias_label}/{alias_id} or use the CSV Export API instead.

In Onesignal's words

This is a Legacy API. Use View User or CSV Export API instead.

Onesignal, Announcement

Facts

API
Onesignal onesignal.com
Kind
Endpoint removal
Takes effect
No date given yet
Calls after that day
Fail
Source
Announcement
Last updated
Verified
, against Onesignal's own pages

Questions

When does this change take effect?

Onesignal deprecated GET /api/v1/players/{id} without giving a shutdown date yet.

Do these calls still work?

Yes, they still work: Onesignal has not given a shutdown date yet.

How do I find the calls this hits in my code?

Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.


More from Onesignal 4

  1. No date /api/v1/apps/{id}/users/{id}Endpoint removal Deprecated, no date
  2. No date GET /api/v1/playersEndpoint removal Deprecated, no date
  3. No date POST /api/v1/playersEndpoint removal Deprecated, no date
  4. No date PUT /api/v1/players/{id}Endpoint removal Deprecated, no date

Is your code calling this?

Okapi finds the calls this change hits in your repo and opens the pull request with the fix.

Add to GitHub

Get notifications

Subscribe to Onesignal

Hear about each breaking change Onesignal announces, in your feed reader, calendar or Slack.

1What to follow

Provider
  • Onesignal

2Where to get it

/breaking-changes/feed.xml

Paste it into Feedly, Inoreader, NetNewsWire or any reader. New changes show up as they're announced.