peskybird
API reference › Your account

List your topics

GEThttps://peskybird.app/api/push/topics
Auth App token

The topics a token may send to, and how many devices receive each, so you know someone will get the message.

Every topic for a token without a scope; the scope's names for one with a scope, including names with no topic yet.

Response 200

The topics, by name.

  • autoCreatebooleanRequired

    Whether sending to a topic that does not exist yet creates it.

  • topicsobject[]Required

    The topics this token may send to, by name.

    Fields of each item (4)
    • namestringRequired

      Topic name, unique per server: lowercase letters and digits in groups joined by single hyphens (like home-automation), 1 to 32 characters.

      at most 32 characters
    • existsbooleanRequired

      False for a name in the token's scope that has no topic yet; sending to it creates the topic when the server auto-creates topics.

    • subscribersintegerRequired

      Active devices that receive messages on this topic (subscribed and not muted).

    • createdAtdate-time

      RFC 3339 / ISO 8601 timestamp with offset; UTC recommended.

Errors

401unauthorized: The Authorization header is missing, or the token is not valid or has been revoked.
403forbidden: The token may not send to this topic, or the account does not allow what was asked. details.reason says which: topic_limit, images_not_enabled or account_suspended.
429rate_limited: The account reached its daily limit, or the token sent too fast.

Every error uses the same envelope. Error format and codes