Overview

Rewrite list endpoints use cursor-based pagination. Every paginated response returns:

data: the current page items
cursor: pagination state for the next or previous request

Response format

{
  "ok": true,
  "data": [],
  "cursor": {
    "persist": true,
    "next": "748395130237498399",
    "prev": "748395130237498420"
  }
}

Cursor fields

persist: Whether more results exist.
next: Cursor to use for the next page.
prev: Cursor to use for the previous page.

Treat cursor.next and cursor.prev as opaque values.

Query parameters

after: Fetch results after a given ID.
before: Fetch results before a given ID.
limit: Number of items to return (2 to 100).

Forward pagination

Use after to move forward.

rewrite webhooks list --limit 25 --after 9213923891293040

const rewrite = new Rewrite(process.env.REWRITE_API_KEY);

const { data, error, cursor } = await rewrite.webhooks.list({
  limit: 25,
});

if (error) throw error;

if (cursor?.persist) {
  const { data: nextData, error: nextError, cursor: nextCursor } =
    await rewrite.webhooks.list({
      limit: 25,
      after: cursor.next,
    });

  if (nextError) throw nextError;
}

package main

import (
    rewrite "github.com/rewritetoday/golang"
)

func main() {
    client := rewrite.New("rw_abcxyz")

    data, cursor, err := client.Webhooks.List(25)
    if err != nil {
        panic(err)
    }

    if cursor != nil && cursor.Persist {
        nextData, nextCursor, err := client.Webhooks.List(
            25,
            rewrite.Webhooks.ListOptions{After: cursor.Next},
        )
        if err != nil {
            panic(err)
        }

        _, _ = nextData, nextCursor
    }

    _ = data
}

import rewrite

client = rewrite.Rewrite("rw_abcxyz")

data, error, cursor = client.webhooks.list(limit=25)

if error:
    raise Exception(error)

if cursor and cursor.persist:
    next_data, next_error, next_cursor = client.webhooks.list(
        limit=25,
        after=cursor.next,
    )

    if next_error:
        raise Exception(next_error)

curl -X GET 'https://api.rewritetoday.com/v1/webhooks?limit=25&after=9213923891293040' \
     -H 'Authorization: Bearer rw_abcxyz'

http GET 'https://api.rewritetoday.com/v1/webhooks?limit=25&after=9213923891293040' \
     'Authorization: Bearer rw_abcxyz'

Backward pagination

Use before to move backward.

rewrite webhooks list --limit 25 --before 9213923891293040

const rewrite = new Rewrite(process.env.REWRITE_API_KEY);

const { data, error, cursor } = await rewrite.webhooks.list({
  limit: 25,
});

if (error) throw error;

if (cursor?.persist) {
  const { data: nextData, error: nextError, cursor: nextCursor } =
    await rewrite.webhooks.list({
      limit: 25,
      before: cursor.next,
    });

  if (nextError) throw nextError;
}

package main

import (
    rewrite "github.com/rewritetoday/golang"
)

func main() {
    client := rewrite.New("rw_abcxyz")

    data, cursor, err := client.Webhooks.List(25)
    if err != nil {
        panic(err)
    }

    if cursor != nil && cursor.Persist {
        nextData, nextCursor, err := client.Webhooks.List(
            25,
            rewrite.Webhooks.ListOptions{Before: cursor.Next},
        )
        if err != nil {
            panic(err)
        }

        _, _ = nextData, nextCursor
    }

    _ = data
}

import rewrite

client = rewrite.Rewrite("rw_abcxyz")

data, error, cursor = client.webhooks.list(limit=25)

if error:
    raise Exception(error)

if cursor and cursor.persist:
    next_data, next_error, next_cursor = client.webhooks.list(
        limit=25,
        before=cursor.next,
    )

    if next_error:
        raise Exception(next_error)

curl -X GET 'https://api.rewritetoday.com/v1/webhooks?limit=25&before=9213923891293040' \
     -H 'Authorization: Bearer rw_abcxyz'

http GET 'https://api.rewritetoday.com/v1/webhooks?limit=25&before=9213923891293040' \
     'Authorization: Bearer rw_abcxyz'

Common mistakes

Using before and after
Inferring the end from length
Treating cursors as generated values

Do not send before and after in the same request.

Do not use length < limit to detect the end of the list. Use cursor.persist.

Reference

Messages

API Keys

Contacts

Segments

OTP

Tags

Templates

Webhooks

Logs

Deliveries

Pagination

Overview

Response format

Cursor fields

Query parameters

Common mistakes

​Overview

​Response format

​Cursor fields

​Query parameters

​Forward pagination

​Backward pagination

​Common mistakes

Overview

Response format

Cursor fields

Query parameters

Forward pagination

Backward pagination

Common mistakes